Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check Documentation and add algorithm usage examples (cloned) #10450

Closed
NickDraper opened this issue Jun 6, 2014 · 3 comments
Closed

Check Documentation and add algorithm usage examples (cloned) #10450

NickDraper opened this issue Jun 6, 2014 · 3 comments
Assignees
Labels
Documentation Issues and pull requests related to documentation High Priority An issue or pull request that if not addressed is severe enough to postponse a release. Stale This label is automatically applied to issues that are automatically closed by the stale bot

Comments

@NickDraper
Copy link
Contributor

This issue was originally TRAC 9607

Cloned from http://trac.mantidproject.org/mantid/ticket/9576:


Please check the documentation for these algorithms (check images, formatting etc) and add testable algorithm usage examples. We have tried to allocate algorithms as fairly and sensibly as possible, but there will be some that you do not consider "yours".

There is help on how to document the algorithms in the following links:
http://www.mantidproject.org/Algorithm_Documentation
http://www.mantidproject.org/Algorithm_Usage_Examples
And there are examples implemented for '''Fit, Load, LoadISISNexus''' and '''Rebin'''.

To create workspaces to use in your usages you should try to create the workspace using CreateSampleWorkspace or CreateWorkspace, and only use a file if you really have no other option and the size is small.

In Visual studio you have two targets to create the documentation and run the doc tests (docs-html and docs-test in a documentation subfolder). You will need to update your Third Party Library.

If you are using Linux/Mac look here: https://github.com/mantidproject/mantid/blob/master/Code/Mantid/docs/README.md

  1. SpecularReflectionCalculateTheta.cpp
  2. CalculateUMatrix.cpp
  3. CentroidPeaks.cpp
  4. FindClusterFaces.cpp
  5. IntegratePeaksUsingClusters.cpp
  6. SetSpecialCoordinates.cpp
  7. SortXAxis.py
  8. AndMD.cpp
  9. CloneMDWorkspace.cpp
  10. CreateMDWorkspace.cpp
  11. DivideMD.cpp
  12. EqualToMD.cpp
  13. LessThanMD.cpp
  14. MinusMD.cpp
  15. MultiplyMD.cpp
  16. NotMD.cpp
  17. OrMD.cpp
  18. PlusMD.cpp
  19. SetMDUsingMask.cpp
  20. TransformMD.cpp
  21. WeightedMeanMD.cpp
  22. XorMD.cpp
  23. GreaterThanMD.cpp
  24. SetSpecialCoordinates.cpp
@NickDraper
Copy link
Contributor Author

@OwenArnold (2014-07-11T10:43:06):
No time to get this into the 3.2 release

@NickDraper NickDraper added High Priority An issue or pull request that if not addressed is severe enough to postponse a release. Documentation Issues and pull requests related to documentation labels Jun 3, 2015
@stale
Copy link

stale bot commented Feb 24, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. If you feel this is incorrect please comment to keep it alive, with a reason why.

To prevent closure, e.g. for long-term planning issues, add the "Never Stale" label.

@stale stale bot added the Stale This label is automatically applied to issues that are automatically closed by the stale bot label Feb 24, 2021
@stale
Copy link

stale bot commented Mar 3, 2021

This issue has been closed automatically. If this still affects you please re-open this issue with a comment so we can look into resolving it.

@stale stale bot closed this as completed Mar 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues and pull requests related to documentation High Priority An issue or pull request that if not addressed is severe enough to postponse a release. Stale This label is automatically applied to issues that are automatically closed by the stale bot
Projects
None yet
Development

No branches or pull requests

2 participants