pytest-dev / pytest-dev/pytest-django
Write docstring to fixtures
Open
Beginner friendly
Nobody has claimed this yet.
help wanted
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 367
- PR merge metrics
- No merged PRs in 30d
Description
This is what I get when running pytest --fixtures:
.
.
.
django_db_modify_db_settings_xdist_suffix
...python3.5/site-packages/pytest_django/fixtures.py:23: no docstring available
.
.
.
django_db_modify_db_settings
...python3.5/site-packages/pytest_django/fixtures.py:51: no docstring available
django_db_use_migrations
...python3.5/site-packages/pytest_django/fixtures.py:56: no docstring available
django_db_keepdb
...python3.5/site-packages/pytest_django/fixtures.py:61: no docstring available
.
.
.
mailoutbox
...python3.5/site-packages/pytest_django/plugin.py:428: no docstring available
.
.
.
Contributor guide
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 with the listed fixtures in fixtures.py and plugin.py, using pytest --fixtures to inspect their current output. Add docstrings for the fixtures reported as having none, then rerun pytest --fixtures and confirm those entries no longer show "no docstring available".
Written by the indexing model from the issue text.
Assessment
- Tech stack
- django, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 78/100