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

GH-69564: Clarify use of octal format of mode argument in help(os.chmod) #20621

Merged
merged 7 commits into from Dec 21, 2022

Conversation

amaajemyfren
Copy link
Contributor

@amaajemyfren amaajemyfren commented Jun 3, 2020

Copy link
Contributor

@remilapeyre remilapeyre left a comment

Should os.rst be updated too? Also, I think the docstring of os.fchmod() should be updated as well.

@amaajemyfren
Copy link
Contributor Author

amaajemyfren commented Jun 11, 2020

Hi @remilapeyre,

apologies for responding after a long time.

Should os.rst be updated too?

Currently the main documentation does not have the ambiguity that exists in help('os.chmod'):

image

It avoids this in part by not getting into the details of what the values of mode are; by abstracting away some of that complexity in the stat module.

I feel that changing it could be changing documentation that has little issues to make it align with the help blurb?

Also, I think the docstring of os.fchmod() should be updated as well.

On my system it currently (3.8.3) says:

image

Would you like to be added explicit descriptions for fd and mode?

@amaajemyfren
Copy link
Contributor Author

amaajemyfren commented Jun 12, 2020

Hi, @remilapeyre,
I have changed help(os.fchmod) but not os.rst.

I need to know if this is still considered a documentation change that does not need a NEWS entry or whether I should generate one please.

@remilapeyre
Copy link
Contributor

remilapeyre commented Jul 20, 2020

Thanks for making the changes @amaajemyfren ! Can you please fix the conflicts with the master branch?

@merwok
Copy link
Member

merwok commented Nov 22, 2022

@amaajemyfren sorry this PR fell out of people’s radar — could you merge the main branch and regenerate the file?

@kumaraditya303 kumaraditya303 changed the title bpo-25377: Clarify use of octal format of mode argument in help(os.chmod) GH-69564: Clarify use of octal format of mode argument in help(os.chmod) Dec 21, 2022
@kumaraditya303 kumaraditya303 merged commit bbf4a66 into python:main Dec 21, 2022
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants