Opened 2 years ago

Closed 2 years ago

#21687 closed Cleanup/optimization (wontfix)

Document the abstract models testing

Reported by: jocelyn@… Owned by: JocelynD
Component: Documentation Version: master
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


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)

0001-Added-a-topic-on-testing-abstract-models.patch (1.3 KB) - added by JocelynD 2 years ago.
documentation edit proposal (master)

Download all attachments as: .zip

Change History (7)

comment:1 Changed 2 years ago by timo

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted
  • Type changed from Uncategorized to Cleanup/optimization

Sure, if you could submit a patch I'll be happy to review it.

comment:2 Changed 2 years ago by JocelynD

  • Owner changed from nobody to JocelynD
  • Status changed from new to assigned

Ok, working on it.

Changed 2 years ago by JocelynD

documentation edit proposal (master)

comment:3 Changed 2 years ago by JocelynD

  • Cc JocelynD added
  • Has patch set

comment:4 Changed 2 years ago by timo

  • 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 Changed 2 years ago by mjtamlyn

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 Changed 2 years ago by timo

  • Resolution set to wontfix
  • Status changed from assigned to closed

Closing per Marc's concerns.

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