docs icon indicating copy to clipboard operation
docs copied to clipboard

arguments page formatting

Open danbjoseph opened this issue 4 years ago • 0 comments

The arguments were previously formatted as a Sphinx definition list. Which was nice in that (I thought) it excluded the first line, the term, from the translation flow. But I double checked and the multi-word lines (i.e. those with options included after the argument on the line) still got shown to the translators. Which resulted in a hodgepodge in the translation files. So, I don't ask that we go back to the previous formatting and am okay with the line starting with a code block (and not being recognized as definition list with "terms" as Sphinx calls it). But could we...


  1. Annoyingly, the angle brackets are interpreted as HTML and so are locked from translation but show up oddly in the interface. Could we wrap the input type definitions in curly brackets? Then instead of... Screen Shot 2021-01-15 at 3 54 54 PM ...the translation interface would show: Screen Shot 2021-01-15 at 5 00 23 PM This would also make the below read instead as "{ float > 0.0 }" which I think is less likely to cause initial confusion. Screen Shot 2021-01-15 at 4 51 00 PM

  1. Can we wrap the option list included on the first line in square brackets [] or adjust styling at all? Are any of the options after the first below formatted better? Screen Shot 2021-01-15 at 4 52 13 PM Screen Shot 2021-01-15 at 5 06 12 PM Screen Shot 2021-01-15 at 5 05 43 PM Screen Shot 2021-01-15 at 5 10 43 PM

  1. It looks like there's an empty space and extra period that is a placeholder for a list of options that's not being included on some of the entries? Screen Shot 2021-01-15 at 4 54 37 PM In 2 of the entries, the options are listed in the description: Screen Shot 2021-01-15 at 5 02 28 PM & Screen Shot 2021-01-15 at 5 02 50 PM

  1. The code in the descriptions now just renders as plain text, although I'm not sure what can be done about this. Screen Shot 2021-01-15 at 4 56 14 PM It's not that bad other than for the file format lines... Screen Shot 2021-01-15 at 4 57 42 PM

danbjoseph avatar Jan 15 '21 22:01 danbjoseph