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.
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.
About this issue
- Original URL
- State: closed
- Created 3 years ago
- Comments: 17 (13 by maintainers)
Commits related to this issue
- [DOC] Fix inconsistent double backticks in similarity_search module (#809) — committed to adityagh006/aeon by adityagh006 2 years ago
- Fix inconsistent docstring formatting for issue #809 — committed to an04shu/aeon_ by an04shu 2 years ago
- [DOC] Fixed inconsistent backticks in docstrings #809 — committed to an04shu/aeon_ by an04shu 2 years ago
- Fix docstring inconsistencies in benchmarking module - resolves #809 — committed to adityagh006/aeon by adityagh006 2 years ago
- Fix docstring inconsistencies in benchmarking module - resolves #809 — committed to adityagh006/aeon by adityagh006 2 years ago
- Fix docstring inconsistencies in benchmarking module - resolves #809 — committed to adityagh006/aeon by adityagh006 2 years ago
- Fix docstring inconsistencies in benchmarking module - resolves #809 — committed to adityagh006/aeon by adityagh006 2 years ago
- Fix docstring inconsistencies in benchmarking module (resolves #809) (#2735) * issue#809 Fix docstrings for benchmarking functions * Fixed docstrings in results_loaders.py * Fix docstring inconsist... — committed to Kaustbh/aeon by adityagh006 2 years ago
- [ENH] Add ETS/ARIMA Stuff (#2536) * forecaster base and dummy * forecasting tests * forecasting tests * forecasting tests * forecasting tests * regression * notebook * regressor * regressor ... — committed to aeon-toolkit/aeon by alexbanwell1 2 years ago
- [ENH] Add ETS/ARIMA Stuff (#2536) * forecaster base and dummy * forecasting tests * forecasting tests * forecasting tests * forecasting tests * regression * notebook * regressor * regressor ... — committed to aeon-toolkit/aeon by alexbanwell1 2 years ago
- [ENH] Add ETS/ARIMA Stuff (#2536) * forecaster base and dummy * forecasting tests * forecasting tests * forecasting tests * forecasting tests * regression * notebook * regressor * regressor ... — committed to aeon-toolkit/aeon by alexbanwell1 2 years ago
- [DOC] resolved the inconsistency of double ticks for the anomaly detection module #809 (#2546) * resolved the inconsistency of double quotes * resolved the inconsistency of double ticks * resolved ... — committed to aeon-toolkit/aeon by AnaghDeshpande a year ago
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