[DOC] Inconsistent double tick quotes in docstrings

[zy18811]

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.

[TonyBagnall]

I think double ticks is preferable

[adityagh006]

Hi @TonyBagnall, I'd like to work on this issue. Could you please assign it to me?

[MatthewMiddlehurst]

Please read our contributor guide. It would be a bit much to do this for the whole package, why not select a module then post here that you will be working on it?

[Val-2608]

Hi ,I'd like to work on resolving any inconsistencies in the documentation for the regression module.

[AnaghDeshpande]

Hi, @MatthewMiddlehurst i would like to work on anomaly_detection

[NasheetaFarzana]

Hello @MatthewMiddlehurst @TonyBagnall. I would like to work on this project. But as a beginner I need your guidance for how to start contributing ( mainly improving the documentation and docstrings ) in the code.

[MatthewMiddlehurst]

Hi @NasheetaFarzana that depends on how experienced you are really. I would look at our contributing guide on the website. As i mentioned on Slack for stuff such as how to use Git, GitHub, or learning Python we are not the place unfortunetly.

[nMaax]

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