aeon: [DOC] Inconsistent double tick quotes in docstrings

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.

image

Docstring for n_jobs uses double ticks for -1 to represent it referring to code.

image

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.

About this issue

  • Original URL
  • State: closed
  • Created 3 years ago
  • Comments: 17 (13 by maintainers)

Commits related to this issue

Most upvoted comments

Hello @MatthewMiddlehurst , I would like to work on the backticks in “aeon/classification/distance_based”.

Undecided on whether we want it or not for private methods. Definitely want it for public ones.

Hi @MatthewMiddlehurst , I noticed some inconsistencies in the segmentation module and would like to work on fixing them. It doesn’t seem to me anyone else is working exactly on this module, just wanted to check if I can proceed.

Edit: Already forked and made commits on my fork’s branch with all the updates, only thing to do now is the pull request

Hi, @MatthewMiddlehurst i would like to work on anomaly_detection