Opened 12 years ago

Closed 12 years ago

Last modified 12 years ago

#19497 closed Cleanup/optimization (fixed)

Refactor testing docs

Reported by: Ramiro Morales Owned by: nobody
Component: Documentation Version: dev
Severity: Normal Keywords: testing documentation
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by Ramiro Morales)

Currently we have only one document that all overview, in-depth and reference topics that IMHO is too bloated.

I've refactored it a bit so reading of the main document can be performed in a more natural way without so many distractions.

Changes include:

  • Move introductory material to a simple document (index.txt)
  • Create a advanced document and move there description of
    • RequestFactory
    • API for custom test runners and integration with other testing frameworks/coverage.py.
    • Advanced multi-db testing topics.
  • Move the doctests documentation to its own document.
  • Add links to the new testing tutorial and among the documnts
  • In the main document: Reorder the TestCase classes sections following their OOP hierarchy. Make titles nesting less deep.

PR is at: https://github.com/django/django/pull/602

Change History (8)

comment:1 by Ramiro Morales, 12 years ago

Description: modified (diff)

comment:2 by Ramiro Morales, 12 years ago

Copying Preston great idea in #19498, here is a rendered copy of the refactored docs: https://dl.dropbox.com/u/5403630/testing-docs-rf/topics/testing/index.html

comment:3 by Russell Keith-Magee, 12 years ago

Triage Stage: UnreviewedAccepted

comment:4 by Tim Graham, 12 years ago

+1, thanks Ramiro, I had been thinking about this myself. I've left some small comments on the pull request.

in reply to:  4 comment:5 by Ramiro Morales, 12 years ago

Replying to timo:

+1, thanks Ramiro, I had been thinking about this myself. I've left some small comments on the pull request.

Thanks Tim for your attention to detail, docs look much better now.

I've addressed all your notes but unfortunately I messed up the branch by rebasing from master in the middle of the work and as a result the PR is too noisy (Git lesson learned). Please review only the relevant commit https://github.com/ramiro/django/commit/616c2a5efec6021f6aa175ea53f994dbc52a6f52

Once the refactor is ready I will create a new PR or commit directly to master.

comment:6 by Tim Graham, 12 years ago

Looks good to me.

comment:7 by Ramiro Morales <cramm0@…>, 12 years ago

Resolution: fixed
Status: newclosed

In d19109fd37e75ccf29d2ca64370102753dbc7c5b:

Fixed #19497 -- Refactored testing docs.

Thanks Tim Graham for the review and suggestions.

comment:8 by Ramiro Morales <cramm0@…>, 12 years ago

In 903892be7b51bd22c10a6e6f49a7a2ee67fd2288:

[1.5.x] Fixed #19497 -- Refactored testing docs.

Thanks Tim Graham for the review and suggestions.

d19109fd37e75ccf29d2ca64370102753dbc7c5b from master.

Note: See TracTickets for help on using tickets.
Back to Top