Re: [Docutils-develop] commit r9245 Use literal syntax in HISTORY

[Adam T. <aat...@ou...>]

Dear Günter,

> the commit r9245 eliminates the deliberate distinction between Python
> object names (up to r9244 marked up with the default "title-reference"
> role, not *emphasis*!) and filenames or code examples (marked up as
> "inline literal").

Thank you for the clarification.

I suggest documenting this in a comment at the start of the HISTORY file, as the distinction was entirely lost on me. We might also consider using explicit markup for clarity (either ``:title:``, or a custom code role ``:py:``).

For programme names, such as "pandoc", "flake8", and "2to3", what syntax would we use? Following the rule outlined in your note, these would use literal syntax, I believe, though I would like to check before reverting a reversion.

There are some Python names that were previously using literal syntax that should likely be modified, e.g. "HTMLTranslator.topic_classes", "use_latex_toc", "split_escaped_whitespace", etc.

Finally, for expressions in the HISTORY file (e.g. "parts['title']", "footnote_backlinks==False", etc), what syntax should we use?

Thanks,
Adam