Skip to content

inaccurate documentation #7336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
shilobar opened this issue Jun 8, 2020 · 7 comments · Fixed by #9878
Closed

inaccurate documentation #7336

shilobar opened this issue Jun 8, 2020 · 7 comments · Fixed by #9878
Labels
good first issue easy issue that is friendly to new contributor plugin: logging related to the logging builtin plugin type: docs documentation improvement, missing or needing clarification

Comments

@shilobar
Copy link

shilobar commented Jun 8, 2020

In https://docs.pytest.org/en/5.4.3/reference.html, under "log_file", it says: "Sets a file name relative to the pytest.ini file"

Instead, the log file is created relative to the directory where pytest was invoked.

I ran pytest _test.py in a subdirectory, with a pytest.ini a few directories above it, with the following config:

[pytest]
python_files = _test*.py
testpaths = lib
log_cli = True
log_cli_level = DEBUG
log_file = pytest-logs.txt
log_file_level = DEBUG

A pytest-logs.txt was created in the directory where I ran pytest.

I'm running:
pytest 5.4.3
macOs 10.15.4

@Zac-HD Zac-HD added good first issue easy issue that is friendly to new contributor type: docs documentation improvement, missing or needing clarification labels Jun 9, 2020
@shilobar
Copy link
Author

Btw, I'm not sure if this is a documentation issue or a bug.

@RonnyPfannschmidt RonnyPfannschmidt added type: bug problem that needs to be addressed plugin: logging related to the logging builtin plugin type: backward compatibility might present some backward compatibility issues which should be carefully noted in the changelog and removed type: docs documentation improvement, missing or needing clarification labels Jun 10, 2020
@symonk
Copy link
Member

symonk commented Jun 10, 2020

I will grab this one, thanks

@codeslash21
Copy link

Hii, I can see that this issue is not closed. Can I take this issue?

@The-Compiler
Copy link
Member

@codeslash21 @symonk already opened #7350 for this (see the link above your comment).

@reynaldipriandika
Copy link

hay everybody, I know that I'm really new to contribute in open source project, so please help me with all your kindness. Can you tell me how I can contribute for this issue ?. Thanks a lot

@symonk
Copy link
Member

symonk commented Oct 31, 2020

Feel free to take this, using my PR as a starting point 😀 I’m working on some other issues at the moment

@symonk symonk removed their assignment Jul 29, 2021
@frnsimoes
Copy link

Hey, everyone. Is it ok if I try this out? Thanks!

@Zac-HD Zac-HD added type: docs documentation improvement, missing or needing clarification and removed type: bug problem that needs to be addressed type: backward compatibility might present some backward compatibility issues which should be carefully noted in the changelog labels Apr 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue easy issue that is friendly to new contributor plugin: logging related to the logging builtin plugin type: docs documentation improvement, missing or needing clarification
Projects
None yet
8 participants