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.

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

docs: Add glossary term references to shutil docs #115559

Merged
merged 2 commits into from
Feb 16, 2024

Conversation

brianschubert
Copy link
Contributor

@brianschubert brianschubert commented Feb 16, 2024

Add links to the glossary terms "file object" and "path-like object" at their first uses in the documentation for various shutil functions.

I linked "file-like object" mentions directly to the term "file object", since this is what's done in the os docs.

This seemed trivial enough for skip issue, but I'm happy to go back and create one if needed.

Previous discussion


📚 Documentation preview 📚: https://cpython-previews--115559.org.readthedocs.build/

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Feb 16, 2024
@hugovk
Copy link
Member

hugovk commented Feb 16, 2024

Please could you undo the re-wrapping? It makes it very hard to see what's been changed.

@hugovk hugovk added needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Feb 16, 2024
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @brianschubert !

@CAM-Gerlach CAM-Gerlach merged commit 318f219 into python:main Feb 16, 2024
27 checks passed
@miss-islington-app
Copy link

Thanks @brianschubert for the PR, and @CAM-Gerlach for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 16, 2024
Add glossary term references to shutil docs
(cherry picked from commit 318f219)

Co-authored-by: Brian Schubert <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Feb 16, 2024

GH-115578 is a backport of this pull request to the 3.12 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 16, 2024
Add glossary term references to shutil docs
(cherry picked from commit 318f219)

Co-authored-by: Brian Schubert <[email protected]>
@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Feb 16, 2024
@bedevere-app
Copy link

bedevere-app bot commented Feb 16, 2024

GH-115579 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Feb 16, 2024
@CAM-Gerlach CAM-Gerlach self-assigned this Feb 16, 2024
CAM-Gerlach pushed a commit that referenced this pull request Feb 16, 2024
…115579)

docs: Add glossary term references to shutil docs (GH-115559)

Add glossary term references to shutil docs
(cherry picked from commit 318f219)

Co-authored-by: Brian Schubert <[email protected]>
CAM-Gerlach pushed a commit that referenced this pull request Feb 16, 2024
…115578)

docs: Add glossary term references to shutil docs (GH-115559)

Add glossary term references to shutil docs
(cherry picked from commit 318f219)

Co-authored-by: Brian Schubert <[email protected]>
woodruffw pushed a commit to woodruffw-forks/cpython that referenced this pull request Mar 4, 2024
diegorusso pushed a commit to diegorusso/cpython that referenced this pull request Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants