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.

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

bpo-33943: Add references to logging.basicConfig #7858

Merged
merged 4 commits into from
Jun 25, 2018
Merged

bpo-33943: Add references to logging.basicConfig #7858

merged 4 commits into from
Jun 25, 2018

Conversation

andresdelfino
Copy link
Contributor

@andresdelfino andresdelfino commented Jun 22, 2018 •
edited by bedevere-bot
Loading

taleinat
taleinat requested changes Jun 24, 2018
View reviewed changes
Doc/library/logging.rst Outdated
| | <old-string-formatting>`, |
| | :meth:`str.format` or |
| | :class:`string.Template` respectively. |
| | Defaults to ``'%'`` |
Copy link
Contributor

Choose a reason for hiding this comment

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

Missing a period at the end.

Doc/library/logging.rst Outdated
+--------------+---------------------------------------------+
| ``format`` | Use the specified format string for the |
| | handler. |
+--------------+---------------------------------------------+
| ``datefmt`` | Use the specified date/time format. |
| ``datefmt`` | Use the specified :func:`time.strftime` |
| | style date/time format. |
Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest a different wording, to avoid the non-hyphenated use of "style", e.g.:

"Use the specified date/time format, as accepted by time.strftime."

Doc/library/logging.rst Outdated
| ``filemode`` | Specifies the mode to open the file, if |
| | filename is specified (if filemode is |
| | unspecified, it defaults to 'a'). |
| ``filemode`` | If ``filename`` is specified, open the file |
Copy link
Contributor

Choose a reason for hiding this comment

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

Use *filename* rather than ``filename`` (here and elsewhere).

From the Documenting Python page in the developers guide:

Names of local variables, such as function/method arguments, are an exception, they should be marked simply with *var*.

@bedevere-bot
Copy link

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.

@andresdelfino
Copy link
Contributor Author

I have made the requested changes; please review again

Thanks for the review, Tal!

@bedevere-bot
Copy link

Thanks for making the requested changes!

@taleinat: please review the changes made to this pull request.

taleinat
taleinat approved these changes Jun 25, 2018
View reviewed changes
Copy link
Contributor

@taleinat taleinat left a comment

Choose a reason for hiding this comment

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

This looks great to me!

@taleinat taleinat merged commit a8ddf85 into python:master Jun 25, 2018
@miss-islington
Copy link
Contributor

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

@miss-islington
Copy link
Contributor

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

@miss-islington
Copy link
Contributor

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

@bedevere-bot
Copy link

GH-7899 is a backport of this pull request to the 3.6 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 25, 2018
@andresdelfino @miss-islington
bpo-33943: Add references in the docs for logging.basicConfig (python…
e14d966 
…GH-7858)

Adds references to info about file modes, `time.strftime()`, string formatting
syntaxes, and logging levels.
(cherry picked from commit a8ddf85)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
@miss-islington
Copy link
Contributor

Sorry, @andresdelfino and @taleinat, I could not cleanly backport this to 2.7 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker a8ddf85a84364d2c660e6670a7e06621993d1fdc 2.7

@bedevere-bot
Copy link

GH-7900 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 Jun 25, 2018
@andresdelfino @miss-islington
bpo-33943: Add references in the docs for logging.basicConfig (python…
64958c0 
…GH-7858)

Adds references to info about file modes, `time.strftime()`, string formatting
syntaxes, and logging levels.
(cherry picked from commit a8ddf85)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
taleinat pushed a commit that referenced this pull request Jun 25, 2018
@miss-islington @andresdelfino @taleinat
bpo-33943: Add references in the docs for logging.basicConfig (GH-7858)…
66d77d8 
… (GH-7900)

Adds references to info about file modes, `time.strftime()`, string formatting
syntaxes, and logging levels.

(cherry picked from commit a8ddf85)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
taleinat pushed a commit to taleinat/cpython that referenced this pull request Jun 25, 2018
@andresdelfino @taleinat
[3.5] bpo-33943: Add references in the docs for logging.basicConfig (p…
bf7194a 
…ythonGH-7858)

Adds references to info about file modes, `time.strftime()`, string formatting
syntaxes, and logging levels.
(cherry picked from commit a8ddf85)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
taleinat pushed a commit that referenced this pull request Jun 25, 2018
@miss-islington @andresdelfino @taleinat
bpo-33943: Add references in the docs for logging.basicConfig (GH-7858)…
73848e0 
… (GH-7899)

Adds references to info about file modes, `time.strftime()`, string formatting
syntaxes, and logging levels.

(cherry picked from commit a8ddf85)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
taleinat pushed a commit to taleinat/cpython that referenced this pull request Jun 25, 2018
@andresdelfino @taleinat
[2.7] bpo-33943: Add references in the docs for logging.basicConfig (p…
7e022c5 
…ythonGH-7858)

Adds references to info about file modes, `time.strftime()`, string formatting
syntaxes, and logging levels..
(cherry picked from commit a8ddf85)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
@bedevere-bot
Copy link

GH-7902 is a backport of this pull request to the 2.7 branch.

taleinat added a commit that referenced this pull request Jun 25, 2018
@taleinat @andresdelfino
[2.7] bpo-33943: Add references in the docs for logging.basicConfig (G…
aa770b7 
…H-7858) (GH-7902)

Adds references to info about file modes, `time.strftime()`, string formatting
syntaxes, and logging levels.

(cherry picked from commit a8ddf85)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
@taleinat taleinat added the docs Documentation in the Doc dir label Jun 25, 2018
@andresdelfino andresdelfino deleted the logging-references branch June 25, 2018 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@taleinat taleinat taleinat approved these changes

Assignees

@taleinat taleinat

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

Successfully merging this pull request may close these issues.
5 participants
@andresdelfino @bedevere-bot @miss-islington @taleinat @the-knights-who-say-ni