Skip to content

Clarify argument types in datetime docs. #15459

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 1 commit into from
Aug 24, 2019
Merged

Clarify argument types in datetime docs. #15459

merged 1 commit into from
Aug 24, 2019

Conversation

jugmac00
Copy link
Contributor

@jugmac00 jugmac00 commented Aug 24, 2019 •
edited by miss-islington
Loading

"Arguments may be integers... " could be misunderstand as they also
could be strings.

New wording makes it clear that arguments have to be integers.

modified: Doc/library/datetime.rst

Automerge-Triggered-By: @pganssle

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Aug 24, 2019
@jugmac00
Copy link
Contributor Author

Also see #15008

brandtbucher
brandtbucher approved these changes Aug 24, 2019
View reviewed changes
Copy link
Member

@brandtbucher brandtbucher left a comment •
edited
Loading

Choose a reason for hiding this comment

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

This can probably skip issue and skip news. Do you mind changing the title to be more descriptive, though? Maybe something like "Clarify argument types in datetime docs."

@jugmac00
Clarify argument types in datetime docs.
1b785b2 
"Arguments may be integers... " could be misunderstand as they also
could be strings.

New wording makes it clear that arguments have to be integers.

modified:   Doc/library/datetime.rst
@jugmac00
Copy link
Contributor Author

@brandtbucher Thank you for the review. Changed the title as you required.

@brandtbucher
Copy link
Member

brandtbucher commented Aug 24, 2019 •
edited
Loading

@jugmac00 Sorry, I should have been clearer. I actually meant the GitHub PR title. The commit message is fine!

@jugmac00 jugmac00 changed the title Improve wording. Clarify argument types in datetime docs. Aug 24, 2019
@jugmac00
Copy link
Contributor Author

Updated the title of the PR.

I have not touched the commit message again - if you want me to switch back to "Improve wording." title - just give a quick note, otherwise I hope the PR is fine now :-)

Thanks for your time and effort!

@brandtbucher brandtbucher mentioned this pull request Aug 24, 2019
Closed
ned-deily
ned-deily approved these changes Aug 24, 2019
View reviewed changes
Copy link
Member

@ned-deily ned-deily left a comment

Choose a reason for hiding this comment

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

LGTM. Awaiting review by one of the datetime core developers (@abalkin or @pganssle).

@pganssle pganssle closed this Aug 24, 2019
@pganssle pganssle reopened this Aug 24, 2019
pganssle
pganssle approved these changes Aug 24, 2019
View reviewed changes
Copy link
Member

@pganssle pganssle 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 @jugmac00.

Sorry I accidentally closed this PR, I actually have no idea how that happened.

@miss-islington
Copy link
Contributor

@jugmac00: Status check is done, and it's a success ✅ .

@miss-islington miss-islington merged commit c5218fc into python:master Aug 24, 2019
@miss-islington
Copy link
Contributor

Thanks @jugmac00 for the PR 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-15472 is a backport of this pull request to the 3.8 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 24, 2019
@jugmac00 @miss-islington
Clarify argument types in datetime docs. (pythonGH-15459)
8718d63 
"Arguments may be integers... " could be misunderstand as they also
could be strings.

New wording makes it clear that arguments have to be integers.

modified:   Doc/library/datetime.rst

Automerge-Triggered-By: @pganssle
(cherry picked from commit c5218fc)

Co-authored-by: Jürgen Gmach <juergen.gmach@googlemail.com>
@bedevere-bot
Copy link

GH-15473 is a backport of this pull request to the 3.7 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 24, 2019
@jugmac00 @miss-islington
Clarify argument types in datetime docs. (pythonGH-15459)
521c93d 
"Arguments may be integers... " could be misunderstand as they also
could be strings.

New wording makes it clear that arguments have to be integers.

modified:   Doc/library/datetime.rst

Automerge-Triggered-By: @pganssle
(cherry picked from commit c5218fc)

Co-authored-by: Jürgen Gmach <juergen.gmach@googlemail.com>
@jugmac00 jugmac00 deleted the improve-wording branch August 24, 2019 19:54
miss-islington added a commit that referenced this pull request Aug 24, 2019
@miss-islington
[3.8] Clarify argument types in datetime docs. (GH-15459) (GH-15472)
ffe43b2 
"Arguments may be integers... " could be misunderstand as they also
could be strings.

New wording makes it clear that arguments have to be integers.

modified:   Doc/library/datetime.rst



Automerge-Triggered-By: @pganssle
(cherry picked from commit c5218fc)


Co-authored-by: Jürgen Gmach <juergen.gmach@googlemail.com>

Automerge-Triggered-By: @pganssle
miss-islington added a commit that referenced this pull request Aug 24, 2019
@miss-islington @jugmac00
Clarify argument types in datetime docs. (GH-15459)
d9140a2 
"Arguments may be integers... " could be misunderstand as they also
could be strings.

New wording makes it clear that arguments have to be integers.

modified:   Doc/library/datetime.rst

Automerge-Triggered-By: @pganssle
(cherry picked from commit c5218fc)

Co-authored-by: Jürgen Gmach <juergen.gmach@googlemail.com>
lisroach pushed a commit to lisroach/cpython that referenced this pull request Sep 10, 2019
@jugmac00 @lisroach
Clarify argument types in datetime docs. (pythonGH-15459)
996da74 
"Arguments may be integers... " could be misunderstand as they also
could be strings.

New wording makes it clear that arguments have to be integers.

modified:   Doc/library/datetime.rst



Automerge-Triggered-By: @pganssle
DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
@jugmac00 @DinoV
Clarify argument types in datetime docs. (pythonGH-15459)
bb10e4c 
"Arguments may be integers... " could be misunderstand as they also
could be strings.

New wording makes it clear that arguments have to be integers.

modified:   Doc/library/datetime.rst



Automerge-Triggered-By: @pganssle
websurfer5 pushed a commit to websurfer5/cpython that referenced this pull request Jul 20, 2020
@jugmac00 @websurfer5
Clarify argument types in datetime docs. (pythonGH-15459)
e03c8ca 
"Arguments may be integers... " could be misunderstand as they also
could be strings.

New wording makes it clear that arguments have to be integers.

modified:   Doc/library/datetime.rst



Automerge-Triggered-By: @pganssle
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pganssle pganssle pganssle approved these changes

@ned-deily ned-deily ned-deily approved these changes

@brandtbucher brandtbucher brandtbucher approved these changes

@abalkin abalkin Awaiting requested review from abalkin

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@jugmac00 @brandtbucher @miss-islington @bedevere-bot @pganssle @ned-deily @the-knights-who-say-ni