Ticket #9878 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Add Usage Data Notes to RST files of #9567 needing such

Reported by: Karl Palmen Owned by: Karl Palmen
Priority: major Milestone: Release 3.3
Component: Documentation Keywords: maintenance
Cc: Blocked By:
Blocking: Tester: Harry Jeffery

Description

Add ".. include:: ../usagedata-note.txt" to the usage examples of algorithms provided with such in #9567 that make use of usage data files in the usage example.

Change History

comment:1 Changed 6 years ago by Karl Palmen

  • Keywords maintenance added
  • Status changed from new to assigned

comment:2 Changed 6 years ago by Karl Palmen

  • Status changed from assigned to inprogress

comment:3 Changed 6 years ago by Karl Palmen

The RST files for the following algorithms need usage data note adding:

  1. ApplyCalibration
  2. CopyInstrumentParameters
  3. CreateCalFileByNames
  4. CreateDummyCalFile
  5. CreateGroupingWorkspace
  6. LoadFullprofResolution
  7. LoadGSASInstrumentFile
  8. LoadIDFFromNexus

Also ApplyDetailedBalance needs example title correcting.

comment:4 Changed 6 years ago by Karl Palmen

Made changes to RST files re #9878

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 924fc1a28d866a4f01e1236a1ad3bbbcf3300290

comment:5 Changed 6 years ago by Karl Palmen

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

To test, build the documents and check that the algorithms listed have a usage data note at the start of the usage section and such algorithms need it.

comment:6 Changed 6 years ago by Harry Jeffery

  • Status changed from verify to verifying
  • Tester set to Harry Jeffery

comment:7 Changed 6 years ago by Harry Jeffery

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9878_rst_usage_data_notes'

Full changeset: ​627b0d838f7d4db142eabdeebffc0a805f14436f

comment:8 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​10720

Note: See TracTickets for help on using tickets.