-
Notifications
You must be signed in to change notification settings - Fork 210
[DOC] Inconsistent double tick quotes in docstrings #809
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
I think double ticks is preferable |
Hi @TonyBagnall, I'd like to work on this issue. Could you please assign it to me? |
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? |
Hi ,I'd like to work on resolving any inconsistencies in the documentation for the regression module. |
Hi, @MatthewMiddlehurst i would like to work on anomaly_detection |
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. |
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. |
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 |
Also, I was looking at PR #2574 and noticed that @MatthewMiddlehurst mentioned to do not insert double ticks in private docstrings (i.e. those related to modules not listed in I decided to write this follow-up question here rather than in the Slack server so that also others can easily read about this detail when they first encounter this Issue, if this is not appropriate tell me and I will proceed to delete this comment and move it to Slack :) |
Hi @MatthewMiddlehurst, I'd like to work on resolving the double backtick inconsistencies in the similarity_search module. |
Undecided on whether we want it or not for private methods. Definitely want it for public ones. |
Hello @MatthewMiddlehurst , |
Hi @MatthewMiddlehurst , I'd like to work on the classification module. I will change all the single quotes (') to double backticks(``) in all the docstrings |
I noticed an inconsistency in how code elements are formatted in Aeon's docstrings—some references use single backticks (e.g., 'int', 'RandomState'), while others use double backticks (e.g., -1). This leads to inconsistent rendering in the API docs, where single backticks result in italics instead of proper code formatting. |
Hello @MatthewMiddlehurst , |
Hi, @MatthewMiddlehurst i would like to work on forecasting module |
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.
The text was updated successfully, but these errors were encountered: