pytest-dev / pytest-dev/pytest-html
Documentation/comments : Could you better document the hooks arguments type ?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 779
- Forks
- 260
- PR merge metrics
- No merged PRs in 30d
Description
Could,
Could you add more comments to the code and Readme files so that we can better understand the type of objects and the attributes of the following parameters :
- report
- prefix
- summary
- postfix
- cells
- data
I found them in the following hookers:
- def pytest_html_report_title(report):
- def pytest_html_results_summary(prefix, summary, postfix):
- def pytest_html_results_table_header(cells):
- def pytest_html_results_table_row(report, cells):
- def pytest_html_results_table_html(report, data):
By reading the source code, I have no idea what kind of attributes of methods each parameter has.
Thank you
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
Locate the hook definitions and the README sections for pytest_html_report_title, pytest_html_results_summary, pytest_html_results_table_header, pytest_html_results_table_row, and pytest_html_results_table_html. Read how report, prefix, summary, postfix, cells, and data are used, then document their object types and relevant attributes in the source comments and README; done means each listed argument is understandable to hook users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100