Ticket #9182 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Remove unwanted indentation from wiki sections of algorithms

Reported by: Karl Palmen Owned by: Karl Palmen
Priority: major Milestone: Release 3.2
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: #8917 Tester: Roman Tolchenov

Description

The following algorithms have their wiki comments indented causing the wiki description to appear in a bad format. Remove this indentation, except when really needed.

ApplyDetailedBalance, ClearUB, CreateTransmissionWorkspace, FindPeaks, GeneralisedSecondDifference, GoniometerAnglesFromPhiRotation, HFIRSANSReduction, LoadILLSANS, LoadSINQFocus, OptimizeCrystalPlacement, PerformIndexOperations, ReflectometryReductionOne, SANSAzimuthalAverage1D, SANSBeamSpreaderTransmission, SANSDirectBeamTransmission, SaveToSNSHistogramNexus (summary), SaveVTK (summary), ShowPeakHKLOffsets, ThresholdMD.

Change History

comment:1 Changed 7 years ago by Nick Draper

  • Status changed from new to assigned
  • Owner set to Karl Palmen

comment:2 Changed 7 years ago by Karl Palmen

  • Status changed from assigned to inprogress

comment:3 Changed 7 years ago by Karl Palmen

Remove unwanted indentations from wiki re #9182

Also I tidied some wiki sections, breaking up long lines, which are hostile to the code reader.

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

Changeset: c38b3703b230467489709ddf2fbc5fb19dc29be3

comment:4 Changed 7 years ago by Karl Palmen

To test, in the code review check that the wiki indentation has been removed in all the algorithms listed, except where needed. For the more complicated cases, run wikimaker to check that the format is OK.

Check that no changes made except wiki comments and summary strings.

comment:5 Changed 7 years ago by Karl Palmen

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

comment:6 Changed 7 years ago by Roman Tolchenov

  • Status changed from verify to verifying
  • Tester set to Roman Tolchenov

comment:7 Changed 7 years ago by Roman Tolchenov

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9182_wiki_indent'

Full changeset: ​4681445a1e0f139cb49328c09412a1bc938aaf1f

comment:8 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​10025

Note: See TracTickets for help on using tickets.