Skip to content

separate format arg doc for shutil.make_archive #103829

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

Merged
merged 2 commits into from
Feb 2, 2024

Conversation

michalkaptur
Copy link
Contributor

format argument description does not follow the formatting standard of placing each argument in a new paragraph, making it hard to read. Fixed that by prepending newlines to the description.

image

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news awaiting review labels Apr 25, 2023
@ghost
Copy link

ghost commented Apr 25, 2023

All commit authors signed the Contributor License Agreement.
CLA signed

@michalkaptur michalkaptur force-pushed the fix_shutil_docs_format branch from d6780fd to b148b00 Compare August 17, 2023 06:18
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

Some parameters can be grouped together, for example owner and group. But I agree that the description of the format parameter is long enough and is better in its own paragraph.

LGTM. Thank you for your contribution.

@serhiy-storchaka serhiy-storchaka added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Feb 2, 2024
@serhiy-storchaka serhiy-storchaka enabled auto-merge (squash) February 2, 2024 09:58
@serhiy-storchaka serhiy-storchaka merged commit 53339a0 into python:main Feb 2, 2024
@miss-islington-app
Copy link

Thanks @michalkaptur for the PR, and @serhiy-storchaka 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 2, 2024
@bedevere-app
Copy link

bedevere-app bot commented Feb 2, 2024

GH-114897 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 Feb 2, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 2, 2024
@bedevere-app
Copy link

bedevere-app bot commented Feb 2, 2024

GH-114898 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 2, 2024
serhiy-storchaka pushed a commit that referenced this pull request Feb 2, 2024
…ragraph (GH-103829) (GH-114898)

(cherry picked from commit 53339a0)

Co-authored-by: Michal Kaptur <[email protected]>
serhiy-storchaka pushed a commit that referenced this pull request Feb 2, 2024
…ragraph (GH-103829) (GH-114897)

(cherry picked from commit 53339a0)

Co-authored-by: Michal Kaptur <[email protected]>
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.

4 participants