Skip to content

gh-141127: Clarify os.symlink() documentation for argument order #141144

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
Nov 9, 2025
Merged

gh-141127: Clarify os.symlink() documentation for argument order #141144

merged 3 commits into from
Nov 9, 2025

Conversation

@chillakalyan
Copy link
Contributor

@chillakalyan chillakalyan commented Nov 6, 2025 •
edited by pradyunsg
Loading

Summary

This pull request clarifies the documentation for os.symlink() to make the argument order unambiguous and consistent with Unix conventions.

before

os.symlink(src, dst, target_is_directory=False, *, dir_fd=None)
Create a symbolic link pointing to src named dst.

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

@python-cla-bot
Copy link

python-cla-bot bot commented Nov 6, 2025 •
edited
Loading

All commit authors signed the Contributor License Agreement.

CLA signed

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news labels Nov 6, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Nov 6, 2025
@chillakalyan chillakalyan changed the title bpo-141127: Clarify os.symlink() documentation for argument order gh-141127: Clarify os.symlink() documentation for argument order Nov 6, 2025
@bedevere-app bedevere-app bot mentioned this pull request Nov 6, 2025
Closed
StanFromIreland
StanFromIreland reviewed Nov 6, 2025
View reviewed changes
picnixz
picnixz requested changes Nov 7, 2025
View reviewed changes
@bedevere-app
Copy link

bedevere-app bot commented Nov 7, 2025

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

chillakalyan
chillakalyan commented Nov 7, 2025
View reviewed changes
Copy link
Contributor Author

@chillakalyan chillakalyan left a comment

Choose a reason for hiding this comment

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

I have made the requested changes; please review again.

picnixz
picnixz approved these changes Nov 7, 2025
View reviewed changes
Copy link
Member

@picnixz picnixz left a comment

Choose a reason for hiding this comment

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

We could update the docstring if it needs to be kept in sync.

@picnixz picnixz merged commit 7ae440f into python:main Nov 9, 2025
31 of 32 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Nov 9, 2025
@picnixz picnixz added awaiting merge needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Nov 9, 2025
@miss-islington-app
Copy link

miss-islington-app bot commented Nov 9, 2025

Thanks @chillakalyan for the PR, and @picnixz for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@miss-islington-app
Copy link

miss-islington-app bot commented Nov 9, 2025

Thanks @chillakalyan for the PR, and @picnixz for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 9, 2025
@chillakalyan @miss-islington
pythongh-141127: Clarify o?s.symlink() documentation for argument ord…
932d2e7 
…er (pythonGH-141144)

(cherry picked from commit 7ae440f)

Co-authored-by: Chilla Kalyan <127284726+chillakalyan@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Nov 9, 2025

GH-141277 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Nov 9, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 9, 2025
@chillakalyan @miss-islington
pythongh-141127: Clarify o?s.symlink() documentation for argument ord…
674b1be 
…er (pythonGH-141144)

(cherry picked from commit 7ae440f)

Co-authored-by: Chilla Kalyan <127284726+chillakalyan@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Nov 9, 2025

GH-141278 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Nov 9, 2025
@bedevere-app
Copy link

bedevere-app bot commented Nov 9, 2025

GH-141277 is a backport of this pull request to the 3.13 branch.

@picnixz
Copy link
Member

picnixz commented Nov 9, 2025

Huh, I added a ? in the commit message by mistake :')

@bedevere-app
Copy link

bedevere-app bot commented Nov 9, 2025

GH-141278 is a backport of this pull request to the 3.14 branch.

picnixz pushed a commit that referenced this pull request Nov 9, 2025
@miss-islington @chillakalyan
[3.14] gh-141127: Clarify os.symlink() documentation for argument ord…
432432b 
…er (GH-141144) (#141278)

gh-141127: Clarify os.symlink() documentation for argument order (GH-141144)
(cherry picked from commit 7ae440f)

Co-authored-by: Chilla Kalyan <127284726+chillakalyan@users.noreply.github.com>
picnixz pushed a commit that referenced this pull request Nov 9, 2025
@miss-islington @chillakalyan
[3.13] gh-141127: Clarify os.symlink() documentation for argument ord…
052a539 
…er (GH-141144) (#141277)

gh-141127: Clarify os.symlink() documentation for argument order (GH-141144)
(cherry picked from commit 7ae440f)

Co-authored-by: Chilla Kalyan <127284726+chillakalyan@users.noreply.github.com>
@StanFromIreland
Copy link
Member

StanFromIreland commented Nov 9, 2025

Huh, I added a ? in the commit message by mistake :')

It’s a questionable commit message;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StanFromIreland StanFromIreland StanFromIreland left review comments

@pradyunsg pradyunsg pradyunsg approved these changes

@picnixz picnixz picnixz approved these changes

Assignees

No one assigned

Labels

awaiting merge docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@chillakalyan @picnixz @StanFromIreland @pradyunsg