Ticket #7496 (closed: fixed)
Calibration move detailed documentation to python pages (Easy to test)
Reported by: | Gesner Passos | Owned by: | Gesner Passos |
---|---|---|---|
Priority: | major | Milestone: | Release 2.6 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | Tester: | Jay Rainey |
Description
There are some wiki documentation available for the Calibration there are not more easily accessible:
TubeSpec, Tube_calib, IdealTube, TubeCalibFitParams.
The information found there would be better if placed inside the code documentation found at http://download.mantidproject.org/docs/master/python/html/techiniques/calibration.html
Work on this.
Change History
comment:2 Changed 7 years ago by Gesner Passos
Provide access to the implementation details for Calibration
Extends the documentation to parse the code inside the methods that implements the calibration and the objects related to it.
re #7496
Changeset: 99b9195b02b93930432d7f39ce326932154a5711
comment:3 Changed 7 years ago by Gesner Passos
- Status changed from inprogress to verify
- Resolution set to fixed
- Summary changed from Calibration move detailed documentation to python pages to Calibration move detailed documentation to python pages (Easy to test)
Tester:
the previous pages that were enable in our wiki were:
- http://www.mantidproject.org/TubeSpec
- http://www.mantidproject.org/Tube_calib
- http://www.mantidproject.org/IdealTube
- http://www.mantidproject.org/TubeCalibFitParams
The information found there (if still valid) must be available inside the python docs, and hopefully improved. Now, you can see only inside the develop branch - http://download.mantidproject.org/docs/develop/python/html/techiniques/calibration_implementation.html, but if you pass this ticket, it will be available on the master link.
comment:4 Changed 7 years ago by Jay Rainey
- Status changed from verify to verifying
- Tester set to Jay Rainey
comment:5 Changed 7 years ago by Jay Rainey
- Status changed from verifying to closed
Documentation has been improved, and relevant Calibration descriptions are now more accessible.