Ticket #11178 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Better differentiate between values and optionality in Default column of algorithm docs

Reported by: Dan Nixon Owned by: Dan Nixon
Priority: minor Milestone: Release 3.4
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: Tester: Federico M Pouzols

Description

Currently Optional and Mandatory are formatted in the same way as the default values even though they are very different things.

Change History

comment:1 Changed 6 years ago by Dan Nixon

  • Status changed from new to assigned

comment:2 Changed 6 years ago by Dan Nixon

  • Status changed from assigned to inprogress

Use italics for optionality in Default column

Refs #11178

Changeset: b65010d56b38ae7b9d4b8bde0d7bf0333ea6137e

comment:3 Changed 6 years ago by Dan Nixon

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

This is being verified as ​pull request #304.

comment:4 Changed 6 years ago by Dan Nixon

Jenkins, retest this please.

comment:5 Changed 6 years ago by Federico M Pouzols

  • Status changed from verify to verifying
  • Tester set to Federico M Pouzols

comment:6 Changed 6 years ago by Federico M Pouzols

Good point. Docs build fine and it now looks nicer/easier to read. One could go for bold face for mandatory props for example, but that would be a bit too much, I think.

comment:7 Changed 6 years ago by Federico M Pouzols

  • Status changed from verifying to closed

Merge pull request #304 from mantidproject/11178_use_italics_for_algo_docs_optionality

Use italics for optionality in algorithm properties Default column

Full changeset: ​83dc367dd215608d2b134a575471604cf9ae9c29

comment:8 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​12017

Note: See TracTickets for help on using tickets.