Commit graph

247 commits

Author SHA1 Message Date
Alex Waygood
d2068c65a6
[3.12] gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs (#124480) (#124558) 2024-09-25 23:01:19 +00:00
Miss Islington (bot)
ca3ac30d6b
[3.12] Remove excessive backticks in logging doc (GH-123813) (#123817)
Remove excessive backticks in logging doc (GH-123813)
(cherry picked from commit 93050e4614)

Co-authored-by: Wei-Hsiang (Matt) Wang <mattwang44@gmail.com>
2024-09-07 18:19:23 +00:00
Miss Islington (bot)
5cca0419cf
[3.12] [doc] Clarify the nature of the root logger in the logging documentation (GH-119440) (GH-119652)
(cherry picked from commit b407ad38fb)
2024-05-28 15:04:19 +01:00
Miss Islington (bot)
b83b3cb9da
[3.12] docs: module page titles should not start with a link to themselves (GH-117099) (#118791)
docs: module page titles should not start with a link to themselves (GH-117099)
(cherry picked from commit bcb435ee8f)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2024-05-08 19:42:01 +00:00
Miss Islington (bot)
663e7bc2ee
[3.12] [doc] Update logging documentation to improve grammar and elucidate an example. (GH-117541) (GH-117542)
(cherry picked from commit df912c913a)
2024-04-04 14:19:10 +01:00
Miss Islington (bot)
0cca76243c
[3.12] gh-98731: Improvements to the logging documentation (GH-101618) (GH-116734)
(cherry picked from commit 7f418fb111)
2024-03-13 17:16:48 +00:00
Miss Islington (bot)
753b6644e3
[3.12] gh-115811: Update documentation to add some Logger attributes. (GH-116109) (GH-116185)
(cherry picked from commit 3b6f4cadf1)
2024-03-01 08:57:30 +00:00
Hugo van Kemenade
cc5870a1d7
[3.12] gh-101100: Fix sphinx warnings in howto/logging.rst (GH-114846) (#114878)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-02-01 20:45:51 +00:00
Erlend E. Aasland
3efcf6673e
[3.12] Docs: align usage of versionadded/versionchanged with recommended practice (#114409) (#114472)
(cherry picked from commit 1d7bddd961)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2024-01-23 10:39:57 +01:00
Miss Islington (bot)
cc12f6684e
[3.12] gh-109451: Fix wrong format specifier in logging documentation (GH-109465) (#109483)
gh-109451: Fix wrong format specifier in logging documentation (GH-109465)
(cherry picked from commit 929cc4e4a0)

Co-authored-by: AlberLC <37489786+AlberLC@users.noreply.github.com>
2023-09-17 22:50:37 +02:00
Miss Islington (bot)
9cd15cab77
[3.12] Docs: document 'manager' and '_log' attrs of logging.Logging (GH-108145) (#108190)
Docs: document 'manager' and '_log' attrs of logging.Logging (GH-108145)
(cherry picked from commit f904aa4e1f)


Authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-08-21 13:16:53 +02:00
Erlend E. Aasland
fa6cd7f43f
[3.12] Docs: Fix Sphinx warnings in logging.rst (GH-108139) (#108174)
(cherry picked from commit c735e79afb)

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-08-20 23:08:16 +02:00
Miss Islington (bot)
ba8ab4e8ae
[3.12] gh-107877: Update logging levels reference table with usage criteria. (GH-107894) (#107922)
gh-107877: Update logging levels reference table with usage criteria. (GH-107894)
(cherry picked from commit cc2cf85d03)

Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-08-14 14:40:47 +02:00
Serhiy Storchaka
d514e1439f
[3.12] gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386) (GH-107419)
(cherry picked from commit f2d07d3289)
2023-07-29 09:16:27 +03:00
Amin Alaee
f2e5a6ee62
gh-102873: logging.LogRecord docs: improve description of msg parameter (#102875)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-24 15:00:32 +00:00
Vinay Sajip
6ad47b41a6
gh-96727: Document restrictions on Handler.emit() with respect to locking. (GH-96948) 2022-09-20 09:40:06 +01:00
Vinay Sajip
d5e07862ec
gh-88287: Add BufferingFormatter documentation. (GH-96608) 2022-09-08 08:22:33 +01:00
Vinay Sajip
29f1b0bb1f
gh-89258: Add a getChildren() method to logging.Logger. (GH-96444)
Co-authored-by: Éric <merwok@netwok.org>
2022-08-31 10:50:29 +01:00
CAM Gerlach
75a6441718
gh-95516: Add param types and clarify param descriptions of LogRecord (GH-95517) 2022-08-02 08:42:35 +01:00
Robert O'Shea
cd26595232
gh-95454: Replace truthy/falsy with true/false (GH-95456) 2022-07-30 00:42:21 -07:00
CAM Gerlach
761eeb62a9
gh-94700: Rewrite the logging.Formatter API ref in structured form (GH-94701) 2022-07-09 06:03:47 +01:00
Vinay Sajip
a391b74dbe
Update logging documentation: change cross-reference and add webapp r… (GH-94540) 2022-07-04 06:06:43 +01:00
Vinay Sajip
e974b3e333
Improve logging documentation with example and additional cookbook re… (GH-93644) 2022-06-09 16:43:35 +01:00
Adrian Garcia Badaracco
296081a7ce
gh-92592: Allow logging filters to return a LogRecord. (GH-92591) 2022-06-07 16:53:57 +01:00
Vinay Sajip
1b74803991
gh-93162: Add ability to configure QueueHandler/QueueListener together (GH-93269)
Also, provide getHandlerByName() and getHandlerNames() APIs.

Closes #93162.
2022-06-07 10:20:35 +02:00
jackh-ncl
cc377063ef
gh-91513: Add 'asyncio' taskName to logging LogRecord attributes. (GH-93193) 2022-05-26 09:30:51 +01:00
Nicolas Haller
2176898308
gh-92859: Doc: add info about logging.debug() calling basicConfig() (GH-93063) 2022-05-23 20:18:43 +01:00
Alex Waygood
318c4e91ef
gh-92417: logging docs: Remove warning that only applies to Python <3.2 (#92425) 2022-05-08 08:36:38 -07:00
Ken Jin
c7e7a4b969
bpo-35821: Fix restructuredtext code formatting in logging.rst (GH-29963) 2021-12-07 23:25:13 +08:00
Vinay Sajip
2bf551757e
bpo-35821: Add an example to Logger.propagate documentation. (GH-29841) 2021-12-07 11:15:44 +00:00
Olaf van der Spek
ee464322eb
Move field width to the right field (GH-29344)
Automerge-Triggered-By: GH:vsajip
2021-10-31 10:44:23 -07:00
Sean Leavey
8492b729ae
Fix legacy logging module URL (GH-28528)
The URL listed in the `logging` docs for the original `logging` module leads to a 404. I managed to find the new location for the page and updated the URL.

Automerge-Triggered-By: GH:vsajip
2021-09-23 07:47:10 -07:00
Vinay Sajip
50b72768ff
bpo-43184: Add information about added attribute and method. (GH-27347) 2021-07-25 17:36:30 +01:00
andrei kulakov
8b93f0e696
bpo-43858: Add logging.getLevelNamesMapping() (GH-26459)
Added a function that returns a copy of a dict of logging levels.
2021-06-03 01:12:59 -07:00
Mariusz Felisiak
bbba28212c
bpo-43353: Document that logging.getLevelName() accepts string representation of logging level. (GH-24693)
[bpo-43353]()

Automerge-Triggered-By: GH:vsajip
2021-03-08 03:16:20 -08:00
Andre Delfino
2a35137328
[doc] Link to issue regarding logging.disable level param default value (GH-23726) 2020-12-09 15:37:39 -08:00
Andre Delfino
35cacce525
[doc] Document logging.basicConfig default format (GH-23710)
Automerge-Triggered-By: GH:vsajip
2020-12-09 13:56:17 -08:00
Bar Harel
1e874d5bec
Update logging documentation to tidy up formatting (GH-22173) 2020-09-10 11:50:23 +01:00
Vinay Sajip
76553e5d2e
Add minor clarification in logging documentation. (GH-22167) 2020-09-09 11:21:22 +01:00
Andre Delfino
f5a16b4dbf
[doc] Add link to FileHandler in logging (GH-21940)
Co-authored-by: Andrés Delfino <adelfino@onapsis.com>
2020-09-01 13:59:46 +01:00
Andre Delfino
c3a651ad25
[doc] Fix markup in logging (GH-22008) 2020-08-30 21:36:58 +01:00
Bar Harel
8f192d12af
bpo-40884: Added defaults parameter for logging.Formatter (GH-20668)
Docs and tests are underway.

Automerge-Triggered-By: @vsajip
2020-06-18 07:18:58 -07:00
Mariusz Felisiak
06a35542aa
bpo-40300: Allow empty logging.Formatter.default_msec_format. (GH-19551) 2020-04-17 17:02:47 +01:00
Gregory P. Smith
9b8e74ca77
Clarify a guarantee of the logging module. (GH-19132)
When no additional arguments are passed to logging.debug() and related
methods, no % operation is performed on the passed in message.
2020-03-24 09:48:32 -07:00
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