Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Documents or more formal Documentation? #128326

Open
StanFromIreland opened this issue Dec 29, 2024 · 3 comments
Open

Documents or more formal Documentation? #128326

StanFromIreland opened this issue Dec 29, 2024 · 3 comments
Labels
docs Documentation in the Doc dir

Comments

@StanFromIreland
Copy link
Contributor

Documentation or Documents?

The documentation mostly refers to itself as Python Documentation however scattered around the place you can find Python Documents which I think should be changed to the more common and proper Python Documentation.

Some examples:

image

On the homepage some links have different names than the pages they link to!
image

I included this change in my recent PR #128325
@StanFromIreland StanFromIreland added the docs Documentation in the Doc dir label Dec 29, 2024
@rruuaanng
Copy link
Contributor

I want to ask, is this issue done? Can we close it?

@StanFromIreland
Copy link
Contributor Author

No that was one PR where the change was made, there are still several pages left to do.

@picnixz
Copy link
Contributor

picnixz commented Jan 1, 2025 •
edited
Loading

@AA-Turner WDYT about this? To avoid confusions (like mine!) maybe it's just better to normalize the wording?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
docs issues
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
3 participants
@picnixz @StanFromIreland @rruuaanng