pytest-dev / pytest-dev/pytest

Add more info on set_log_path()

Open
#8,086 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

plugin: logging type: docs
Dominant language
Python
Stars
14.5k
Forks
3.4k
Avg merge
2d 9h
Merged PRs (30d)
35

Description

Live logs says

You can call set_log_path() to customize the log_file path dynamically. This functionality is considered experimental.

It does not explain how to use set_log_path() as a hook.(Maybe which can be done by adding an example)

Related: #5428, #4707

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Live logs section in the linked logging documentation and review the related issues #5428 and #4707 for context on set_log_path(). Update the documentation to explain using set_log_path() as a hook, including an example; done means the hook usage is clear to readers.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, testing-qa
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.