Ticket #8762 (closed: fixed)
Fill in documentation
| Reported by: | Peter Peterson | Owned by: | Peter Peterson |
|---|---|---|---|
| Priority: | major | Milestone: | Release 3.1 |
| Component: | Documentation | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | Tester: | Andrei Savici |
Description
Recently found out that you can add args to the arg-list in the python bindings so the docstrings are (more) correct. This is a time-boxed exercise to fill some of these in.
There will also be some amount of checking in of richer links for generating rst files. This is a placeholder so the knowledge doesn't get lost.
Change History
comment:2 Changed 7 years ago by Peter Peterson
Re #8762. Refactoring to add links to base clases.
Changeset: 9def9fab9e08eef8bf04f9c0c00eaf3a8049ef8d
comment:3 Changed 7 years ago by Peter Peterson
Re #8762. Adding python arguments to Quat and some of IEventWorkspace.
Changeset: 0c8d35b6ba80afbba861ff5632a323d39d3d2b1c
comment:4 Changed 7 years ago by Peter Peterson
- Status changed from inprogress to verify
- Resolution set to fixed
This is on feature/8762_sphinx_timebox.
To test: Since this is a change in documentation, you'll have to look and see that there is more information there. This can be done by looking at the diff, and seeing the help information in python (via "help") for Quat and IEventWorkspace.
comment:5 Changed 7 years ago by Andrei Savici
- Status changed from verify to verifying
- Tester set to Andrei Savici
comment:6 Changed 7 years ago by Andrei Savici
mantid/Code/Mantid/MantidPlot/docs/python/source/conf.py.in in line 117. Needs to be fixed when breathe project is enabled. See ticket #8795
comment:7 Changed 7 years ago by Andrei Savici
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/8762_sphinx_timebox'
Full changeset: 10f78c67eddca3162eb3202c65e99e1d2ac11831
Re #8762. Adding commented out additions for linking to doxygen.
Changeset: d222f5100d2d6b6621daa14e5e636af129722e35