-
-
Notifications
You must be signed in to change notification settings - Fork 32.1k
Missing brackets in docs: logging.handlers.SysLogHandler(address='localhost', SYSLOG_UDP_PORT,... #93108
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
This seems to be a bug in sphinx that has been fixed in recent versions. The docs online have been built with sphinx 3.2.1, and I don't get parentheses when building the docs locally with that sphinx version. If I upgrade sphinx to 3.3.1, I get the parentheses. |
The Python 3.11 docs are built with Sphinx 4.5, and have the brackets again. @JulienPalard what would be the precedent here for fixing this? I don't imagine we can update the Python 3.10 Sphinx version? Sphinx only supports the latest version, so we're very unlikely to get a 3.2.2 release with a backported fix. A |
We'll have to run a test build before pushing this to docs.python.org, but I'm OK to bump Sphinx to 3.3.1 for Python 3.10. The thing we can't easily bump is the |
I'm trying Sphinx==3.4.3, as Sphinx==3.5 is not compatible with Python 3.10 (sphinx-doc/sphinx#9512)... This issue is solved in 3.4.3 \o/ |
Bug was visible on SysLogHandler: bad: SysLogHandler(address='localhost', SYSLOG_UDP_PORT, ... good: SysLogHandler(address=('localhost', SYSLOG_UDP_PORT), ...
Related PR: #93159 |
Fixed in 3.10. As neither 3.9 nor 3.11 were affected, we can close this! Thanks! ✨ 🍰 ✨ |
Documentation
In https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SysLogHandler for Python 3.10.4,
the parentheses are missing for the address parameter, which is a tuple:
class logging.handlers.SysLogHandler(address='localhost', SYSLOG_UDP_PORT, facility=LOG_USER, socktype=socket.SOCK_DGRAM)
This looks like a syntax error...
The Python 3.9 docks are fine. I haven't checked whether this is a local oops of covers other tuple params as well.
The text was updated successfully, but these errors were encountered: