[doc] Add link to FileHandler in logging (GH-21940)

Co-authored-by: Andrés Delfino <adelfino@onapsis.com>
This commit is contained in:
Andre Delfino 2020-09-01 09:59:46 -03:00 committed by GitHub
parent a4c4e17f95
commit f5a16b4dbf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 15 deletions

View File

@ -1166,9 +1166,9 @@ functions.
+--------------+---------------------------------------------+ +--------------+---------------------------------------------+
| Format | Description | | Format | Description |
+==============+=============================================+ +==============+=============================================+
| *filename* | Specifies that a FileHandler be created, | | *filename* | Specifies that a :class:`FileHandler` be |
| | using the specified filename, rather than a | | | created, using the specified filename, |
| | StreamHandler. | | | rather than a :class:`StreamHandler`. |
+--------------+---------------------------------------------+ +--------------+---------------------------------------------+
| *filemode* | If *filename* is specified, open the file | | *filemode* | If *filename* is specified, open the file |
| | in this :ref:`mode <filemodes>`. Defaults | | | in this :ref:`mode <filemodes>`. Defaults |
@ -1192,9 +1192,10 @@ functions.
| | :ref:`level <levels>`. | | | :ref:`level <levels>`. |
+--------------+---------------------------------------------+ +--------------+---------------------------------------------+
| *stream* | Use the specified stream to initialize the | | *stream* | Use the specified stream to initialize the |
| | StreamHandler. Note that this argument is | | | :class:`StreamHandler`. Note that this |
| | incompatible with *filename* - if both | | | argument is incompatible with *filename* - |
| | are present, a ``ValueError`` is raised. | | | if both are present, a ``ValueError`` is |
| | raised. |
+--------------+---------------------------------------------+ +--------------+---------------------------------------------+
| *handlers* | If specified, this should be an iterable of | | *handlers* | If specified, this should be an iterable of |
| | already created handlers to add to the root | | | already created handlers to add to the root |
@ -1213,18 +1214,18 @@ functions.
+--------------+---------------------------------------------+ +--------------+---------------------------------------------+
| *encoding* | If this keyword argument is specified along | | *encoding* | If this keyword argument is specified along |
| | with *filename*, its value is used when the | | | with *filename*, its value is used when the |
| | FileHandler is created, and thus used when | | | :class:`FileHandler` is created, and thus |
| | opening the output file. | | | used when opening the output file. |
+--------------+---------------------------------------------+ +--------------+---------------------------------------------+
| *errors* | If this keyword argument is specified along | | *errors* | If this keyword argument is specified along |
| | with *filename*, its value is used when the | | | with *filename*, its value is used when the |
| | FileHandler is created, and thus used when | | | :class:`FileHandler` is created, and thus |
| | opening the output file. If not specified, | | | used when opening the output file. If not |
| | the value 'backslashreplace' is used. Note | | | specified, the value 'backslashreplace' is |
| | that if ``None`` is specified, it will be | | | used. Note that if ``None`` is specified, |
| | passed as such to :func:`open`, which means | | | it will be passed as such to :func:`open`, |
| | that it will be treated the same as passing | | | which means that it will be treated the |
| | 'errors'. | | | same as passing 'errors'. |
+--------------+---------------------------------------------+ +--------------+---------------------------------------------+
.. versionchanged:: 3.2 .. versionchanged:: 3.2