pytest-dev / pytest-dev/pytest-reportlog
Documentation of json format
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 104
- Forks
- 23
- PR merge metrics
- No merged PRs in 30d
Description
Is the format of the json-stream documented somewhere?
I've tried to follow the code and it appears to be a serialization of a https://docs.pytest.org/en/7.1.x/reference.html#_pytest.reports.TestReport object (or any of the other BaseReport). Is this correct? In that case can that be clarified in documentation?
Also curious if there is any ambition to document the serialized form of the json, or is the reference to the TestReport object enough?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing documentation for the json-stream output and compare it with pytest's TestReport and BaseReport references mentioned in the issue. Clarify whether the serialized form should be documented directly or whether the pytest report reference is sufficient, then update the relevant documentation and verify that it answers both questions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100