Skip to content

GH-105900: Fix pathlib.Path.symlink_to(target_is_directory=...) docs #114035

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
Merged
merged 3 commits into from
Jan 23, 2024
Merged

GH-105900: Fix pathlib.Path.symlink_to(target_is_directory=...) docs #114035

merged 3 commits into from
Jan 23, 2024

Conversation

@barneygale
Copy link
Contributor

@barneygale barneygale commented Jan 13, 2024 •
edited by github-actions bot
Loading

Clarify that target_is_directory only matters if the target doesn't exist.

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

@barneygale
pythonGH-105900: Fix `pathlib.Path.symlink_to(target_is_directory=...…
2cf36e2 
…)` docs

Clarify that *target_is_directory* only matters if the target doesn't
exist.
@barneygale barneygale added docs Documentation in the Doc dir topic-pathlib labels Jan 13, 2024
@bedevere-app bedevere-app bot mentioned this pull request Jan 13, 2024
Closed
@barneygale barneygale added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Jan 13, 2024
@barneygale barneygale requested a review from AA-Turner January 23, 2024 02:39
AA-Turner
AA-Turner reviewed Jan 23, 2024
View reviewed changes
Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

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

On reading this, I was confused by the word 'type', and it took me a second to realise this was file/directory. I've proposed an alternative wording that avoids this, but if I'm overblowing the issue then the current wording seems good.

A

@barneygale
Copy link
Contributor Author

barneygale commented Jan 23, 2024

Thanks Adam :)

@barneygale barneygale merged commit b822b85 into python:main Jan 23, 2024
@miss-islington-app
Copy link

miss-islington-app bot commented Jan 23, 2024

Thanks @barneygale for the PR 🌮🎉.. 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 Jan 23, 2024
@barneygale @miss-islington
pythonGH-105900: Fix `pathlib.Path.symlink_to(target_is_directory=...…
646b70f 
…)` docs (pythonGH-114035)

Clarify that *target_is_directory* only matters if the target doesn't
exist.
(cherry picked from commit b822b85)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 23, 2024
@barneygale @miss-islington
pythonGH-105900: Fix `pathlib.Path.symlink_to(target_is_directory=...…
83e2b46 
…)` docs (pythonGH-114035)

Clarify that *target_is_directory* only matters if the target doesn't
exist.
(cherry picked from commit b822b85)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Jan 23, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Jan 23, 2024
@bedevere-app
Copy link

bedevere-app bot commented Jan 23, 2024

GH-114465 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 Jan 23, 2024
barneygale added a commit that referenced this pull request Jan 23, 2024
@miss-islington @barneygale
[3.12] GH-105900: Fix `pathlib.Path.symlink_to(target_is_directory=..…
ccd8d77 
….)` docs (GH-114035) (#114464)

Clarify that *target_is_directory* only matters if the target doesn't
exist.
(cherry picked from commit b822b85)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
barneygale added a commit that referenced this pull request Jan 23, 2024
@miss-islington @barneygale
[3.11] GH-105900: Fix `pathlib.Path.symlink_to(target_is_directory=..…
1f04ac8 
….)` docs (GH-114035) (#114465)

Clarify that *target_is_directory* only matters if the target doesn't
exist.
(cherry picked from commit b822b85)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@barneygale @aisk
pythonGH-105900: Fix `pathlib.Path.symlink_to(target_is_directory=...…
80e0ade 
…)` docs (python#114035)

Clarify that *target_is_directory* only matters if the target doesn't
exist.
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@barneygale @Glyphack
pythonGH-105900: Fix `pathlib.Path.symlink_to(target_is_directory=...…
374fe1b 
…)` docs (python#114035)

Clarify that *target_is_directory* only matters if the target doesn't
exist.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AA-Turner AA-Turner AA-Turner approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news topic-pathlib

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@barneygale @AA-Turner