Ticket #9653 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Fixes for documentation

Reported by: Owen Arnold Owned by: Nick Draper
Priority: major Milestone: Release 3.2
Component: Documentation Keywords:
Cc: Blocked By: #9627
Blocking: Tester: Samuel Jackson

Description

Issues to be fixed after #9627

  • TestWorkspaceGroupProperty has a bad property description for 'InputWorkspace2'. 'asd' is not sufficient.

Latex math is faulty in the following:

  • OneMinusExponentialCor
  • AnvredCorrection
  • OptimiseCrystalPlacement

Attachments

9653_Documentation.png (99.8 KB) - added by Michael Wedel 6 years ago.

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Status changed from new to assigned

comment:2 Changed 6 years ago by Nick Draper

  • Status changed from assigned to inprogress

re #9653 One improved prop string and a few more math syntax tags

Changeset: 1ffee04f247f702945c46cfc68b29393154773b2

comment:3 Changed 6 years ago by Nick Draper

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

To test:

Check that the pages above look better in the html than they did in the old wiki

comment:4 Changed 6 years ago by Michael Wedel

  • Status changed from verify to verifying
  • Tester set to Michael Wedel

comment:5 Changed 6 years ago by Michael Wedel

  • Status changed from verifying to reopened
  • Resolution fixed deleted

In OptimizeCrystalPlacement, the formula which was previously written as monospace text and has been converted to latex now is broken up over two lines. It became quite hard to read. Maybe it's possible to shorten the equation a bit by replacing "rotate('x', GonRotx)" by something like "R_x(GonRotx)", SampleOrientation by O(PhiRot*ChiRot*OmegaRot) and clarify in the text?

Changed 6 years ago by Michael Wedel

comment:6 Changed 6 years ago by Nick Draper

  • Status changed from reopened to inprogress

re #9653 improve math formatting

Changeset: fb949631d304af3347d906320211b25df6514b00

comment:7 Changed 6 years ago by Nick Draper

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

comment:8 Changed 6 years ago by Samuel Jackson

  • Status changed from verify to verifying
  • Tester changed from Michael Wedel to Samuel Jackson

comment:9 Changed 6 years ago by Samuel Jackson

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9653_doc_fixes'

Full changeset: 54f6e8b417f308587dcae55521ef7eb9f2701f78

comment:10 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10496

Note: See TracTickets for help on using tickets.