Commit Graph

196 Commits

Author SHA1 Message Date
Serhiy Storchaka 42b619ac9a
[3.7] bpo-38738: Fix formatting of True and False. (GH-17083) (GH-17128)
* "Return true/false" is replaced with "Return ``True``/``False``"
  if the function actually returns a bool.
* Fixed formatting of some True and False literals (now in monospace).
* Replaced "True/False" with "true/false" if it can be not only bool.
* Replaced some 1/0 with True/False if it corresponds the code.
* "Returns <bool>" is replaced with "Return <bool>".
(cherry picked from commit 138ccbb022)
2019-11-12 20:07:20 +02:00
Miss Islington (bot) 4f82a53c5d bpo-38235: Correct some arguments names in logging documentation (GH-16571) (GH-16577)
(cherry picked from commit 3142c667b5)

Co-authored-by: Ashley Whetter <AWhetter@users.noreply.github.com>
2019-10-04 09:14:28 +01:00
Miss Islington (bot) 9eb4b2c8a3 bpo-37258: Not a bug, but added a unit test and updated documentation. (GH-14229) (GH-14231)
(cherry picked from commit 0150001653)
2019-06-19 14:46:19 +01:00
Serhiy Storchaka b183750f99
[3.7] bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231). (GH-10253)
(cherry picked from commit 3f819ca138)
2018-10-31 11:00:24 +02:00
Miss Islington (bot) 6802964fb4 Updated documentation on logging.debug(). (GH-9946) (GH-9949)
(cherry picked from commit bbd90e4f62)

Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2018-10-18 11:55:15 +01:00
Dong-hee Na 75f2eb5eca [3.7] bpo-34065: Improve the markup of logging.basicConfig() arguments (GH-8153). (GH-8156)
(cherry picked from commit 2800dcf656)

Co-authored-by: Dong-hee Na <donghee.na92@gmail.com>
2018-07-07 19:12:11 +03:00
Miss Islington (bot) 66d77d8af8 bpo-33943: Add references in the docs for logging.basicConfig (GH-7858) (GH-7900)
Adds references to info about file modes, `time.strftime()`, string formatting
syntaxes, and logging levels.

(cherry picked from commit a8ddf85a84)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-06-25 09:25:58 +03:00
Miss Islington (bot) 4b6691e40f bpo-33400: Removed references to RFC3339 and ISO8601 from the logging documentation. (GH-7297) (GH-7302)
(cherry picked from commit 23cee80cfa)

Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2018-06-01 18:54:30 +01:00
Miss Islington (bot) 0f1a183269
bpo-33641: Convert RFC references into links. (GH-7103)
85% of them are already links.
(cherry picked from commit 0a36ac1a09)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-05-30 22:33:23 -07:00
Miss Islington (bot) eb8516becc bpo-33400: Clarified documentation to indicate no strict adherence to ISO 8601. (GH-6702) (GH-6704)
(cherry picked from commit c4994dc00d)

Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2018-05-28 13:29:13 +01:00
Miss Islington (bot) b571958f54
Improve highlighting of some code blocks. (GH-6401)
(cherry picked from commit 46936d5a71)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-04-09 07:56:44 -07:00
Miss Islington (bot) 82734a6769
Fix typo in logging doc: picked -> pickled (GH-5942)
(cherry picked from commit 982c723384)

Co-authored-by: James Walker <19191463+jdswalker@users.noreply.github.com>
2018-02-28 15:58:58 -08:00
Vinay Sajip a9f8df646a
bpo-32212: Updated logging documentation to make parameter names more consistent with source. (GH-4765) 2017-12-09 11:09:04 +00:00
Arthur Darcet 2f3d6993d7 Fixed sorting order of the LogRecord attributes in the documentation. (GH-4133) 2017-10-27 08:06:20 +01:00
Vinay Sajip 0653fba51c bpo-30862: Updated Logger.setLevel documentation. (GH-2604) 2017-07-06 17:51:28 +01:00
Vinay Sajip 6260d9f203 bpo-30520: Implemented pickling for loggers. (#1956)
Implemented pickling for loggers.
2017-06-06 16:34:29 +01:00
Vinay Sajip 82a6384733 Indented Handler sections for improved clarity. (#1554)
Indented parts of the Handler class documentation for improved presentation, analogous to a recent similar change for the Logger class.
2017-05-12 09:38:13 +01:00
Jim Fasarakis-Hilliard 55ace65eba Closes bpo-30168: indent methods in Logger Class (#1295) 2017-05-07 19:40:18 +01:00
Vinay Sajip d489ac9102 Closes #28524: added default level for logging.disable(). 2016-12-31 11:40:11 +00:00
Serhiy Storchaka 29b0a26822 Fixed double hyphens that are rendered to literal en-dashes in the documenation. 2016-12-04 10:20:55 +02:00
Serhiy Storchaka 807e2f3459 Issue #19795: Fixed formatting a table. 2016-10-19 19:37:20 +03:00
Serhiy Storchaka 4adf01caae Issue #19795: Improved more markups of True/False. 2016-10-19 18:30:05 +03:00
Serhiy Storchaka a97cd2eb17 Issue #19795: Mark up True and False as literal text instead of bold. 2016-10-19 16:43:42 +03:00
Serhiy Storchaka ecf41da83e Issue #19795: Mark up None as literal text. 2016-10-19 16:29:26 +03:00
Terry Jan Reedy fa089b9b0b Issue #22558: Add remaining doc links to source code for Python-coded modules.
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
Georg Brandl 5d94134040 Closes #25910: fix dead and permanently redirected links in the docs. Thanks to SilentGhost for the patch. 2016-02-26 19:37:12 +01:00
Vinay Sajip 46cc4a8f32 Issue #25508: Merged documentation fix from 3.4. 2015-11-24 23:22:48 +00:00
Vinay Sajip 4f44d53770 Issue #25508: Clarify documentation on LogRecord args attribute. 2015-11-24 23:21:15 +00:00
Vinay Sajip 3b4d30a27b Closes #24060: Merged documentation update from 3.4. 2015-05-02 09:47:28 +01:00
Vinay Sajip bbd95a9361 Issue #24060: Made logging.Formatter documentation a little clearer. 2015-05-02 09:46:05 +01:00
Vinay Sajip c58c7d487b Closes #22436: Merged documentation update from 3.4. 2014-09-18 18:02:29 +01:00
Vinay Sajip 2f1cd8a7fc Issue #22436: Improved documentation for getEffectiveLevel() and getLevelName(). 2014-09-18 18:01:12 +01:00
Vinay Sajip 02a8f9e9ac Closes #20537: logging methods now accept an exception instance as well as a Boolean value or exception tuple. Thanks to Yury Selivanov for the patch. 2014-09-14 21:29:11 +01:00
Vinay Sajip d1d4fbff63 Issue #22386: fixed regression. 2014-09-11 23:06:09 +01:00
Vinay Sajip e0d324d02b Issue #21752: Documented change to behaviour of logging.getLevelName(). 2014-06-14 09:26:26 +01:00
Vinay Sajip 65425b4bc6 Issue #21245: updated documentation on exception() method and function. 2014-04-15 23:13:12 +01:00
Vinay Sajip cbefe3b9a0 Added cookbook entry on alternative formatting styles. 2014-01-15 15:09:05 +00:00
Vinay Sajip 350e623623 Clarified documentation note on module-level convenience functions. 2014-01-15 13:28:39 +00:00
Serhiy Storchaka a4d170d985 Removed spaces before commas and periods. 2013-12-23 18:20:51 +02:00
Vinay Sajip 800e11b406 Issue #19902: Added list of logging levels. 2013-12-19 11:50:24 +00:00
Vinay Sajip a9c179bd3e Issue #19789: Clarified documentation for logging.disable. 2013-11-30 22:45:29 +00:00
Serhiy Storchaka fbc1c26803 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:17:13 +02:00
Vinay Sajip 9c10d6b800 Issue #19504: Used American spelling for 'customize'. 2013-11-15 20:58:13 +00:00
Vinay Sajip 9b83d533e2 Corrected some incorrect cross-references. 2013-10-31 01:10:30 +00:00
Vinay Sajip 31b862d40b Issue #18933: Added links to source code. 2013-09-05 23:01:07 +01:00
Georg Brandl 44ea77bd81 Closes #4159: add LaTeX tabular column specifications to tables that otherwise are cut off or have overlapping text. 2013-03-28 13:28:44 +01:00
Vinay Sajip 9fff3865da Issue #17007: Merged minor changes from 3.2. 2013-01-21 21:58:05 +00:00
Vinay Sajip 52b3d34d1c Issue #17007: Made minor changes to documentation wording. 2013-01-21 21:57:10 +00:00
Vinay Sajip f29839e8e8 Issue #17007: Merged doc update from 3.2. 2013-01-21 19:45:27 +00:00
Vinay Sajip 6c4c16cdb8 Issue #17007: Improved logging documentation based on suggestions in the issue. 2013-01-21 19:44:28 +00:00