datapythonista
commented
4 years ago @tonywu1999 do you mind editing the description and providing more context? Imagine a random user wanting to contribute to pandas lands here. We would like to explain what's the problem, why it's useful to fix it, and step by step information on what to do (e.g. We want to add fixes files to ci/code_checks.sh).
Also, if you want to get the list of files to check, and add it in the description (you can use - [ ] docs/source/whatever.rst, so we can easily check the ones that are fixed).
Thanks!
themien
tonywu1999
cleconte987
iahsanujunda
data-RanDan
rajalakshmi139
ShyamDesai
Ayushihelloworld
bsun94
vrushalit
kswarj
SomtochiUmeh
INDIG0N
harsimran44
suresh33661
skregas
kajor3k
In #26933, we made the capitalization of titles consistent. For example, a title used to be capitalized like, "This is the Section Title", and many of the titles in the pandas documentation was changed to a correct format, like "This is the section title".
In #31114, we made a script called
scripts/validate_rst_title_capitalization.pythat extracts all titles in the documentation, making sure that only the first letter of the sentence is uppercase, or words defined in a short list, like Series, DataFrame, etc. The script also outputs how to fix the title as well.We validated capitalization is correct by integrating this script into CI (continuous integration). The idea is that we should run this script through
ci/code_checks.sh, and when title capitalization errors show up on CI, the user should fix those errors on the specified files.To verify the code is working on your side, the command below instructs the program to validate the
doc/source/development/contributing.rstfile. There should be no output from this command as this file as no capitalization errors:./scripts/validate_rst_title_capitalization.py doc/source/development/contributing.rstThis command below instructs the program to validate both
doc/source/index.rstanddoc/source/development/policies.rstfiles.This command produces the output below:
The goal of this issue is to correct the title capitalization of all files in the pandas documentation. In order to see all titles that need to be validated in the documentation folder, one should run the following command below on the command line.
./scripts/validate_rst_title_capitalization.py doc/sourceThis program validates all RST files in the doc/source folder. Once all titles are all correctly validated, we would like to add the above command into the
ci/code_checks.shfile.Here's a checklist of all the files that had at least one incorrectly capitalized heading: