-
Notifications
You must be signed in to change notification settings - Fork 10.5k
[gardening] Use consistent naming of .rst files in docs/ ("CamelCase.rst") #1340
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
[gardening] Use consistent naming of .rst files in docs/ ("CamelCase.rst") #1340
Conversation
@jrose-apple Any objections? |
The main one is that some of these files have internal links, and I'm kind of surprised you didn't see errors when trying to build the docs after making this change. We've also linked directly to some of these files on GitHub, so we might be breaking some of those links. |
@jrose-apple I tried searching for internal links/references to those ten files but I couldn't find any. Do you know where to look for such references? I tried with the following
The changes passes |
@jrose-apple Turns out there was a reference to |
…rst") Fix some cases where "Camel Case.rst" is used instead of "CamelCase.rst". File counts: * Files in repo: 10 242 * Files in repo with spaces in file name: 10 * Files in repo with .rst suffix: 74 * Files in repo with .rst suffix and spaces in file name: 10 In addition to the consistency argument: spaces in file names create unnecessary gotchas when it comes to bash scripting - see below. Before this commit: ``` $ find . -name "*.rst" | xargs ls -dl > /dev/null ls: cannot access ./docs/Dependency: No such file or directory ls: cannot access Analysis.rst: No such file or directory ls: cannot access ./docs/proposals/ObjC: No such file or directory ls: cannot access Interoperation.rst: No such file or directory ls: cannot access ./docs/proposals/C: No such file or directory ls: cannot access Pointer: No such file or directory ls: cannot access Argument: No such file or directory ls: cannot access Interop.rst: No such file or directory ls: cannot access ./docs/proposals/archive/Memory: No such file or directory ls: cannot access and: No such file or directory ls: cannot access Concurrency: No such file or directory ls: cannot access Model.rst: No such file or directory ls: cannot access ./docs/proposals/C: No such file or directory ls: cannot access Pointer: No such file or directory ls: cannot access Interop: No such file or directory ls: cannot access Language: No such file or directory ls: cannot access Model.rst: No such file or directory ls: cannot access ./docs/proposals/rejected/Bridging: No such file or directory ls: cannot access Container: No such file or directory ls: cannot access Protocols: No such file or directory ls: cannot access to: No such file or directory ls: cannot access Class: No such file or directory ls: cannot access Clusters.rst: No such file or directory ls: cannot access ./docs/archive/Namespace: No such file or directory ls: cannot access Level: No such file or directory ls: cannot access Vars: No such file or directory ls: cannot access and: No such file or directory ls: cannot access Top: No such file or directory ls: cannot access Level: No such file or directory ls: cannot access Code.rst: No such file or directory ls: cannot access ./docs/archive/Objective-C: No such file or directory ls: cannot access Interoperability.rst: No such file or directory ls: cannot access ./docs/Pattern: No such file or directory ls: cannot access Matching.rst: No such file or directory ls: cannot access ./docs/Failable: No such file or directory ls: cannot access Initializers.rst: No such file or directory $ ``` After this commit: ``` $ find . -name "*.rst" | xargs ls -dl > /dev/null $ ```
@jrose-apple Fixed a reference to Turns out that I was building without I've now verified the changes with a proper I've now squashed my commits and all references should be correct now :-) |
Okay, then it just depends on what we think about breaking links to these documents (none of which get linked to that often). @gribozavr? |
I don't mind breaking those links, exactly for the reason you mention. |
All right, then I guess consistency should win. Thanks, @practicalswift! |
…ames [gardening] Use consistent naming of .rst files in docs/ ("CamelCase.rst")
Fix some cases where "Camel Case.rst" is used instead of "CamelCase.rst".
File counts:
In addition to the consistency argument: spaces in file names create unnecessary gotchas when it comes to scripting - see below.
Before this commit:
After this commit: