Closed kajor3k closed 1 month ago
Thanks for the PR! I don't think it's that important to update old release notes' capitalization, updating other parts of the documentation is probably more important.
But, this is still appreciated!
Thanks for the PR! I don't think it's that important to update old release notes' capitalization, updating other parts of the documentation is probably more important.
But, this is still appreciated!
Thank you!
You're right - there are more urgent stuff to be done. I started with few files and small improvements throughout the file for two reasons.
First, I wanted to create a PR which could be a template for other newcomers in case they would like to pickup some of the files. I saw that the approach in which all files are being fixed at once is not welcome due to the size of PR, But if nobody else will comment under original story(#32550) I will gradually pickup other files an clean them as well.
The second reason is that this story doesn't make sense if it won't be finished up by turning on this validation on I see that the validation is running, but it is not configured where I was looking for it. code_checks
. But before it can be done, the validation needs to be flawless
There's one error I don't know how to tackle:
doc/source/whatsnew/v2.2.2.rst:15:Heading capitalization formatted incorrectly. Please correctly capitalize "Pandas 2.2.2 is now compatible with numpy 2.0" to "pandas 2.2.2 is now compatible with NumPy 2.0"
"pandas" in underscore is already in the list of exclusions, but here it is the beginning of the title so it is expected to be upperscore
but here it is the beginning of the title so it is expected to be upperscore
From the citing webpage: "When using the project name pandas, please use it in lower case, even at the beginning of a sentence." -- Not sure why this rule was made but it's quite interesting
but here it is the beginning of the title so it is expected to be upperscore
From the citing webpage: "When using the project name pandas, please use it in lower case, even at the beginning of a sentence." -- Not sure why this rule was made but it's quite interesting
Alright, thanks for your response! Then it is clear. pandas should be underscore even at the beginning of the sentence
Not sure why this rule was made but it's quite interesting
This is generally how names are - they are styled in upper/lower case independent of other grammatical rules, and always done in a consistent manner. For example, words may start with an uppercase letter but they don't appear in the middle unless it is a name, e.g. McClain. And you would never see "IPhone" at the beginning of a sentence, it's always "iPhone". You see this with other packages as well, e.g. scikit-learn.
This pull request is stale because it has been open for thirty days with no activity. Please update and respond to this comment if you're still interested in working on this.
Thanks for the pull request, but it appears to have gone stale. If interested in continuing, please merge in the main branch, address any review comments and/or failing tests, and we can reopen.
…snew doc files. Sorted exceptions list alphabetically, for better maintainability, proposed name change from CAPITALIZATION_EXCEPTIONS to CAPITALIZATION_EXCLUSIONS. (#32550)
closescontributes to #32550 (according to the discussion, the story would touch too many files at once, hence the reviewing process would be cumbersome for the reviewer)- [ ] Tests added and passed if fixing a bug or adding a new featuredoc/source/whatsnew/vX.X.X.rst
file if fixing a bug or adding a new feature.