Merge pull request #3407 from rachel1792/master

Fix typo in caplog fixture documentation: Issue #3406
This commit is contained in:
Bruno Oliveira 2018-04-20 17:41:04 -03:00 committed by GitHub
commit f0084608cc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 6 deletions

View File

@ -289,9 +289,9 @@ def caplog(request):
Captured logs are available through the following methods:: Captured logs are available through the following methods::
* caplog.text() -> string containing formatted log output * caplog.text -> string containing formatted log output
* caplog.records() -> list of logging.LogRecord instances * caplog.records -> list of logging.LogRecord instances
* caplog.record_tuples() -> list of (logger_name, level, message) tuples * caplog.record_tuples -> list of (logger_name, level, message) tuples
* caplog.clear() -> clear captured records and formatted log output string * caplog.clear() -> clear captured records and formatted log output string
""" """
result = LogCaptureFixture(request.node) result = LogCaptureFixture(request.node)

1
changelog/3406.doc.rst Normal file
View File

@ -0,0 +1 @@
Fix typo in ``caplog`` fixture documentation, which incorrectly identified certain attributes as methods.

View File

@ -77,9 +77,9 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
Captured logs are available through the following methods:: Captured logs are available through the following methods::
* caplog.text() -> string containing formatted log output * caplog.text -> string containing formatted log output
* caplog.records() -> list of logging.LogRecord instances * caplog.records -> list of logging.LogRecord instances
* caplog.record_tuples() -> list of (logger_name, level, message) tuples * caplog.record_tuples -> list of (logger_name, level, message) tuples
* caplog.clear() -> clear captured records and formatted log output string * caplog.clear() -> clear captured records and formatted log output string
monkeypatch monkeypatch
The returned ``monkeypatch`` fixture provides these The returned ``monkeypatch`` fixture provides these