pytest-dev / pytest-dev/pytest-django

Documentation with helpers is a bit congested

Open
#569 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.5k
Forks
367
PR merge metrics
No merged PRs in 30d

Description

Right now there is one page "helpers", with both markers and fixtures.

I think it'd be more intuitive for readers if markers and fixtures were split off into their own page. In addition, it'd save a level of section indentation in reStructuredText.

Secondly, if/when marks and fixtures is broke up, it should be done into sections, e.g:

Markers (now its own page)

  • Database
    • pytest.mark.django_db
  • URLs
    • pytest.mark.urls
  • Templates
    • pytest.mark.ignore_template_errors

Fixtures (now its own page)

  • Database
    • db
    • transactional_db
  • Settings
    • settings
  • Server
    • live_server
  • RequestFactory
    • rf
    • rf_user #568
    • rf_unauth #568
    • rf_admin #568
  • Client
    • client
    • admin_client
    • user_client #568
  • User
    • django_username_field
    • django_user_model
    • django_user #568
    • admin_user
  • Mail
    • mailoutbox
  • Assertions
    • django_assert_num_queries

When I do this, I can also do a general cleanup of this section to make it more maintainable down the road.

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

Locate the current documentation page titled "helpers" and review how markers and fixtures are organized. Split them into separate pages, reorganize each into the proposed sections, and include the listed helpers; done when the documentation is less indented and the marker and fixture references are complete and maintainable.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.