DOC: Mixed capitalization styles in page titles #16261
Comments
|
+1 for |
|
+1 for consistency. If we adopt sentence case as the preferred style, eventually that convention should be used consistently throughout the NumPy documentation, including in the section headings of the NumPy docstring standard. Currently it has the section headings "Other Parameters" and "See Also" (which actually gets rendered as "See also:" in the HTML output--go figure). |
|
@alize-papp and I are working on this issue (WiMLDS Berlin sprint) |
|
I have already updated |
|
Note that the issue is a little broader than the one example given, it's about consistency of all titles. @misalraj are you interested to go through the docs and check other pages? |
|
Or @lyzlisa and @alize-papp did you start on this? gh-18962 only fixes one page. |
|
I will look into this. @rgommers |
|
Reopening, there is more to do here for other page titles. |
|
Remaining issues (from #19849):
|
|
I will check, |
|
Working on this as part of the PyDataGlobal 2021 NumPy-SciPy sprint |
|
@InessaPawson |
|
@reshamas Yes, please use the |
|
@InessaPawson Does this issue still need work? |
|
@SuzaKrish Yes. The issue was addressed in some parts of the documentation, but not everywhere. |
|
I'd like to work on this as part of the GHC'22 Numpy sprint |
|
I'm taking a shot at this as part of a sprint during PyCon US 2023. |
|
I am looking into this. I assume that proper nouns should remain capitalized when they appear in the middle of a title. However, what qualifies as a "proper noun"? For example, we in
In the case of "scipy" and "numpy" what is the captialization? Is it "scipy", "Scipy", or "SciPy"? And similarly for "numpy". |
|
I won't speak for SciPy (heh), but NumPy refers to the project while numpy is the name of the module. It can be a bit confusing to decide which one to use. |
More toward gh-16261. gh-16261 reported that documentation headings currently have inconsistent capitalization schemes and should be standardized. gh-25016 fixed this for rst files except release notes and NEPS. This PR adjusts the NEPs. The case of 'numpy', 'blas', 'scipy', 'python', 'lapack', 'fortran', 'api', 'pypi', 'cpu', 'abi', 'pr', 'github', 'ssh', 'git', 'f77', 'numba', 'f2py', 'cffi', 'bitgenerator', 'simd', 'swig', 'csv', 'ascii', 'json', 'dataframe', 'ieee', 'matlab', 'pyfort', ' c ', and 'nep' are unchanged. (Perhaps it would be a good idea to check the capitalization of some of these words throughout the documentation, but that is a different issue.)
Page titles in the docs use both
sentence case("How to contribute to the NumPy documentation"), where only the first word is capitalized, andtitle case("Releasing a Version"), which capitalizes principal words (omitting "a", "of", "the", etc.)Mixing styles makes the docs seem disorganized; a uniform style would give a better impression.
I vote that we converge on sentence case, which is contemporary usage almost everywhere, and I volunteer to go through our pages and PR the needed changes.
The text was updated successfully, but these errors were encountered: