[issue22436] logging geteffectivelevel does not document its return value
New submission from R. David Murray: https://docs.python.org/3/library/logging.html#logging.Logger.getEffectiveLevel This says the logging level is returned, but it doesn't mention that what is returned is an integer, nor does it link to whatever method is needed to convert the integer return value into the symbolic name that the user has been using elsewhere in interacting with logging. Indeed, the section that shows the mapping between names and numbers implies that the user of the library never needs to worry about the numbers unless they are creating a new level, but if they want to use getEffectiveLevel, this is not true. -- assignee: docs@python components: Documentation messages: 227047 nosy: docs@python, r.david.murray, vinay.sajip priority: normal severity: normal status: open title: logging geteffectivelevel does not document its return value type: behavior versions: Python 2.7, Python 3.4, Python 3.5 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue22436 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue22436] logging geteffectivelevel does not document its return value
Vinay Sajip added the comment: Users generally use integer values when specifying logging levels, unless they are e.g. using the configuration machinery, when they will specify strings (just because the configuration is in text files). I will update the documentation to try to make things clearer. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue22436 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue22436] logging geteffectivelevel does not document its return value
Roundup Robot added the comment: New changeset dd17c3eda73c by Vinay Sajip in branch '2.7': Issue #22436: Improved documentation for getEffectiveLevel() and getLevelName(). https://hg.python.org/cpython/rev/dd17c3eda73c New changeset 72a91df86b07 by Vinay Sajip in branch '3.4': Issue #22436: Improved documentation for getEffectiveLevel() and getLevelName(). https://hg.python.org/cpython/rev/72a91df86b07 New changeset 49dfe2630ae3 by Vinay Sajip in branch 'default': Closes #22436: Merged documentation update from 3.4. https://hg.python.org/cpython/rev/49dfe2630ae3 -- nosy: +python-dev resolution: - fixed stage: - resolved status: open - closed ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue22436 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue22436] logging geteffectivelevel does not document its return value
R. David Murray added the comment: Ah, yes, I was just being dense, because the context I was in was exactly that context: configuration via strings. Probably no change is required, but if can think of way of making it obvious to someone thinking crooked like I was that would be great. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue22436 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue22436] logging geteffectivelevel does not document its return value
R. David Murray added the comment: Woops, should have looked at the rest of my email. Yes, that change looks great. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue22436 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
