Ticket #9614 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Check Documentation

Reported by: Nick Draper Owned by: Michael Reuter
Priority: critical Milestone: Release 3.2
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: Tester:

Description (last modified by Michael Reuter) (diff)

Cloned from #9580:

Please check the documentation for these algorithms (check images, formatting etc).

There is help on how to document the algorithms in the following links: http://www.mantidproject.org/Algorithm_Documentation

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

  1. FakeMDEventData.cpp
  2. IndexSXPeaks.cpp
  3. GenerateEventsFilter.cpp
  4. GetEi.cpp
  5. Transpose.cpp
  6. SpatialGrouping.cpp
  7. FindDetectorsPar.cpp
  8. LoadCalFile.cpp
  9. LoadDspacemap.cpp
  10. LoadLogsForSNSPulsedMagnet.cpp
  11. LoadNexusLogs.cpp
  12. SaveDaveGrp.cpp

Change History

comment:1 Changed 6 years ago by Nick Draper

Is this clone here for a reason?

comment:2 Changed 6 years ago by Michael Reuter

Yep. Just hadn't gotten around to editing it.

comment:3 Changed 6 years ago by Michael Reuter

  • Description modified (diff)
  • Summary changed from Check Documentation and add algorithm usage examples (cloned) to Check Documentation

comment:4 Changed 6 years ago by Michael Reuter

  • Description modified (diff)

comment:5 Changed 6 years ago by Nick Draper

  • Status changed from new to assigned

comment:6 Changed 6 years ago by Michael Reuter

  • Status changed from assigned to inprogress

comment:7 Changed 6 years ago by Michael Reuter

  • Description modified (diff)

comment:8 Changed 6 years ago by Michael Reuter

  • Description modified (diff)

comment:9 Changed 6 years ago by Michael Reuter

Refs #9614. Documentation fixes to make things look right.

Changeset: 031c831185fe658bd0f03c6b1a0e24155a03f512

comment:10 Changed 6 years ago by Michael Reuter

Re #9614. Merge branch 'feature/9614_documentation_check' into develop

Conflicts:

Code/Mantid/docs/source/algorithms/GetEi-v2.rst

Changeset: 87d5fc2031c0495423311c1a687c3dcf39b4f940

comment:11 Changed 6 years ago by Michael Reuter

  • Status changed from inprogress to verify
  • Resolution set to fixed

The branch can be found ​here.

To test: Run the doc targets and make sure the pages look fine. Usage examples will come in #9615.

comment:12 Changed 6 years ago by Pete Peterson

Merge remote-tracking branch 'origin/feature/9614_documentation_check'

Re #9614.

Conflicts:

Code/Mantid/docs/source/algorithms/GetEi-v2.rst

Changeset: d390b3ec347a8bb45306e22b94b17ea8160360c6

comment:13 Changed 6 years ago by Pete Peterson

  • Status changed from verify to closed

Merge remote-tracking branch 'origin/feature/9614_documentation_check'

Re #9614.

Conflicts:

Code/Mantid/docs/source/algorithms/GetEi-v2.rst

Full changeset: ​d390b3ec347a8bb45306e22b94b17ea8160360c6

comment:14 Changed 6 years ago by Michael Reuter

Re #9614. Merge branch 'feature/9614_documentation_check' into develop

Conflicts:

Code/Mantid/docs/source/algorithms/GetEi-v2.rst

Changeset: 87d5fc2031c0495423311c1a687c3dcf39b4f940

comment:15 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​10457

Note: See TracTickets for help on using tickets.