Opened 11 years ago
Closed 10 years ago
#21687 closed Cleanup/optimization (wontfix)
Document the abstract models testing
Reported by: | Owned by: | JocelynD | |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | documentation, testing |
Cc: | JocelynD | Triage Stage: | Accepted |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | yes |
Easy pickings: | no | UI/UX: | no |
Description
Testing abstract models within reusable apps is easy, as explained here or here.
I think a hint in the doc titled advanced testing topic would be usefull, and you ?
Attachments (1)
Change History (7)
comment:1 by , 11 years ago
Triage Stage: | Unreviewed → Accepted |
---|---|
Type: | Uncategorized → Cleanup/optimization |
by , 11 years ago
Attachment: | 0001-Added-a-topic-on-testing-abstract-models.patch added |
---|
documentation edit proposal (master)
comment:3 by , 11 years ago
Cc: | added |
---|---|
Has patch: | set |
comment:4 by , 11 years ago
Patch needs improvement: | set |
---|
This looks pretty good. A couple comments:
- There should be just 1 newline between sections of the docs.
- eg should be e.g.
- I suggest writing the link to the test database as
:ref:`the test database <the-test-database>`
so that "The" isn't capitalized in the generated text. - It would be helpful to include an example of what a "stub child class" looks like as it may not be obvious to a reader.
Please uncheck "patch needs improvement" if you can make these improvements; thank-you!
comment:5 by , 11 years ago
This approach is basically a hack - it relies on the fact your tests file is not imported by the rest of the code. If there happened to be a utility function which some lazy developer wrote in the tests and then imported into main project code, this model would potentially become visible during other work. As such, I'm at least -0 on including this documentation, but in any case it should come with bigger warnings in the proposed patch.
comment:6 by , 10 years ago
Resolution: | → wontfix |
---|---|
Status: | assigned → closed |
Closing per Marc's concerns.
Sure, if you could submit a patch I'll be happy to review it.