Ticket #8919 (closed: fixed)
Better usage examples in documentation
| Reported by: | Nick Draper | Owned by: | Anders Markvardsen |
|---|---|---|---|
| Priority: | critical | Milestone: | Release 3.2 |
| Component: | Documentation | Keywords: | SSC,2014,All |
| Cc: | Blocked By: | #9472, #9474, #9493, #9496, #9527, #9533, #9534 | |
| Blocking: | Tester: | Nick Draper |
Description
Usage needs to be an actual example of how to use algorithms not just a one line call
Consider if this could be extended to "run" usage examples as unit tests. This might need a pre- and usage setup and evalutation section
Change History
comment:2 Changed 7 years ago by Nick Draper
- Status changed from new to assigned
Bulk move of tickets out of triage (new) to assigned at the introduction of the triage state
comment:11 Changed 6 years ago by Anders Markvardsen
- Status changed from assigned to verify
- Resolution set to fixed
Sphinx doctest was tested as a base for adding usage examples, see blocking tickets for this ticket.
To tester: If this approach is now used to add usage example than pass this ticket
comment:12 Changed 6 years ago by Nick Draper
- Status changed from verify to verifying
- Tester set to Nick Draper
comment:15 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 9762
Note: See
TracTickets for help on using
tickets.
