Closed
Description
Describe the issue linked to the documentation
Single ticks render as italics while double ticks render as code in the api docs, e.g. int v.s. int
. Various methods use this inconsistently, example from the HIVECOTE 2.0 docs below:
Docstring for random_state
uses single ticks (italics) for all references to code, i.e. int, RandomState, and None.
Docstring for n_jobs
uses double ticks for -1
to represent it referring to code.
Suggest a potential alternative/fix
Select preferred approach out of single and double ticks for referring to code in docstrings and apply consistently throughout aeon.