Commit Graph

253 Commits

Author SHA1 Message Date
Serhiy Storchaka 138ccbb022
bpo-38738: Fix formatting of True and False. (GH-17083)
* "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>".
2019-11-12 16:57:03 +02:00
Ashley Whetter 3142c667b5 bpo-38235: Correct some arguments names in logging documentation (GH-16571) 2019-10-04 08:55:14 +01:00
David Röthlisberger 4f0f9f066e logging.Formatter docs: Add missing `validate` parameter, clarify `style` parameter (GH-15222) 2019-09-09 12:29:54 +01:00
Vinay Sajip 0150001653
bpo-37258: Not a bug, but added a unit test and updated documentation. (GH-14229) 2019-06-19 11:46:53 +01:00
Vinay Sajip ca7b504a4d
bpo-37111: Add 'encoding' and 'errors' parameters to logging.basicCon… (GH-14008) 2019-06-17 17:40:52 +01:00
Andre Delfino 3e700e4ca3 Document that logging registers shutdown as an atexit handler (GH-12378) 2019-03-26 05:42:26 +00:00
Serhiy Storchaka 3f819ca138
bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231) 2018-10-31 02:26:06 +02:00
Vinay Sajip bbd90e4f62
Updated documentation on logging.debug(). (GH-9946) 2018-10-18 11:45:58 +01:00
BNMetrics 18fb1fb943 bpo-34844: logging.Formatter enhancement - Ensure style and format string matches in logging.Formatter (GH-9703) 2018-10-15 19:41:36 +01:00
Dong-hee Na 2800dcf656 bpo-34065: Improve the markup of logging.basicConfig() arguments (GH-8153) 2018-07-07 15:36:40 +03:00
Sergey Fedoseev f12028809b versionadded -> versionchanged for all 'X parameter was added' for uniformity. (GH8114)
Per the recommendation in our Developer's Guide:
  https://devguide.python.org/documenting/#paragraph-level-markup
2018-07-05 17:01:16 -07:00
Andrés Delfino a8ddf85a84 bpo-33943: Add references in the docs for logging.basicConfig (GH-7858)
Adds references to info about file modes, `time.strftime()`, string formatting
syntaxes, and logging levels.
2018-06-25 09:06:10 +03:00
Dong-hee Na cf67d6a934 bpo-33897: Add a 'force' keyword argument to logging.basicConfig(). (GH-7873) 2018-06-25 05:11:09 +01:00
Vinay Sajip dde9fdbe45
bpo-33165: Added stacklevel parameter to logging APIs. (GH-7424) 2018-06-05 17:24:18 +01:00
Vinay Sajip 23cee80cfa
bpo-33400: Removed references to RFC3339 and ISO8601 from the logging documentation. (GH-7297) 2018-06-01 10:09:21 +01:00
Serhiy Storchaka 0a36ac1a09
bpo-33641: Convert RFC references into links. (GH-7103)
85% of them are already links.
2018-05-31 07:39:00 +03:00
Vinay Sajip c4994dc00d
bpo-33400: Clarified documentation to indicate no strict adherence to ISO 8601. (GH-6702) 2018-05-04 22:20:54 +01:00
Serhiy Storchaka 46936d5a71
Improve highlighting of some code blocks. (GH-6401) 2018-04-08 19:18:04 +03:00
James Walker 982c723384 Fix typo in logging doc: picked -> pickled (GH-5942) 2018-02-28 15:46:35 -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
Vinay Sajip 9a546530bb Issue #16884: Merged doc fix from 3.2. 2013-01-08 11:26:30 +00:00
Vinay Sajip 21b30827bc Issue #16884: Updated docs to use 'note' directives in a couple of places missed earlier. 2013-01-08 11:25:42 +00:00
Vinay Sajip 0e82fd1f78 Issue #16884: Merged logging documentation fixes from 3.2. 2013-01-07 14:18:19 +00:00
Vinay Sajip e50f4d2220 Issue #16884: updated logging documentation to include lastResort and use 'note' directives where appropriate. 2013-01-07 14:16:52 +00:00
Vinay Sajip 5e1658c5d7 Closes #15399: merged documentation fix from 3.2. 2012-07-20 09:51:20 +01:00
Vinay Sajip 3be7a8bbcf Issue #15399: Added versionchanged for processName. 2012-07-20 09:50:18 +01:00
Vinay Sajip 07162d4142 Closes #14864: Added documentation on how to undo the effects of a logging.disable() call. Thanks to user Guillaume for the suggestion. 2012-05-20 15:37:33 +01:00
Vinay Sajip 69d8493899 Fixes #14864: Added documentation on how to undo the effects of a logging.disable() call. 2012-05-20 15:36:17 +01:00
Vinay Sajip 8bf2aea962 Merged updates to logging reference and HOWTO from 3.2. 2012-04-10 20:00:43 +01:00
Vinay Sajip 074faff925 Updated logging reference and HOWTO. 2012-04-10 19:59:50 +01:00
Jason R. Coombs 30b8e5461d Use PEP-8 style in logging example 2012-03-07 10:26:08 -05:00
Jason R. Coombs 8a56085b51 Merge: Use PEP-8 style in logging example 2012-03-07 10:27:07 -05:00
Éric Araujo 408026c7e8 Merge 3.2 2012-02-26 04:07:37 +01:00
Éric Araujo a6091998af Use const markup instead of a misleading string literal 2012-02-26 02:13:30 +01:00
Vinay Sajip aa8a62dcc0 Merged documentation update from 3.2. 2012-02-20 18:36:12 +00:00
Vinay Sajip fee358b0df logging: clarified documentation for Handler.handleError. 2012-02-20 18:35:26 +00:00
Gregory P. Smith 0ea3ea5e69 Mention the additional way to use the lvl parameter and when it changed. 2012-01-14 13:19:20 -08:00
Gregory P. Smith c1f079f317 Mention the additional way to use the lvl parameter and when it changed. 2012-01-14 12:46:17 -08:00
Benjamin Peterson 79ed84c7f2 use booleans 2011-12-30 13:47:25 -06:00
Benjamin Peterson 88cb2cafe9 merge 3.2 2011-12-30 13:47:49 -06:00
Vinay Sajip ce378d1945 Closes #13459: Merged fix from 3.2. 2011-11-23 08:55:59 +00:00
Vinay Sajip 287f24691d Closes #13459: Clarified documentation on Logger.propagate. Thanks to Mike Fogel for the patch. 2011-11-23 08:54:22 +00:00
Éric Araujo a083823a85 Avoid relying on the default reST role in logging library doc 2011-11-03 04:35:20 +01:00
Éric Araujo 661161ed86 Avoid relying on the default reST role in logging library doc 2011-10-22 19:29:48 +02:00
Vinay Sajip 04d5bc00a2 Closes #13235: Added deprecation for warn() methods and function in logging. 2011-10-21 07:33:42 +01:00
Georg Brandl e10b5e1dbb Fix markup. 2011-06-14 21:09:55 +02:00
Vinay Sajip bf94b0f943 Merged documentation update for Formatter.formatTime. 2011-06-12 11:50:40 +01:00
Vinay Sajip cdc751720e Updated Formatter.formatTime documentation. 2011-06-12 11:44:28 +01:00
Vinay Sajip 95ebf0ef00 Merged documentation update for issue #12206. 2011-06-11 23:04:35 +01:00
Vinay Sajip 0aaa9e1d7b Issue #12206: documentation for LogRecord constructor updated re. the level argument. 2011-06-11 23:03:37 +01:00
Vinay Sajip 89c00ce33a Updated Formatter.formatTime docs to indicate configuration via class attributes. 2011-06-10 19:05:16 +01:00
Vinay Sajip 4a0a31df5c Added 'handlers' argument to logging.basicConfig. 2011-04-11 08:42:07 +01:00
Vinay Sajip 77f8d2962c Normalised whitespace. 2011-04-08 01:34:20 +01:00
Vinay Sajip c46102c98a Updated Formatter documentation. 2011-04-08 01:30:51 +01:00
Vinay Sajip 01094e1fe4 Logging documentation updates. 2010-12-19 13:41:26 +00:00
Vinay Sajip c63619bcf2 Logging documentation reorganised. 2010-12-19 12:56:57 +00:00
Vinay Sajip 7504302875 Logging documentation update. 2010-12-19 06:02:31 +00:00
Vinay Sajip 9a6b400a59 Logging documentation update. 2010-12-14 19:40:21 +00:00
Vinay Sajip fd94b173ce Logging documentation update. 2010-12-13 18:49:08 +00:00
Vinay Sajip 7292b884bd Logging documentation update. 2010-12-13 18:43:57 +00:00
Vinay Sajip 9466fe88a7 Logging documentatio update. 2010-12-13 08:54:02 +00:00
Vinay Sajip 1d5d6856e2 Logging documentation - further update. 2010-12-12 22:47:13 +00:00
Vinay Sajip 97b886dc8c Logging documentation - further update. 2010-12-12 22:45:35 +00:00