#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 )
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.
Change History (8)
comment:1 by , 12 years ago
Description: | modified (diff) |
---|
comment:2 by , 12 years ago
comment:3 by , 12 years ago
Triage Stage: | Unreviewed → Accepted |
---|
follow-up: 5 comment:4 by , 12 years ago
+1, thanks Ramiro, I had been thinking about this myself. I've left some small comments on the pull request.
comment:5 by , 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:7 by , 12 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
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