[issue35732] Typo in library/warnings documentation
New submission from Antoine Wecxsteen <antoine@wecxsteen.net>: Hello, I believe there's a mistake in the documentation of library/warnings. https://docs.python.org/3.8/library/warnings.html#warnings.warn "This function raises an exception if the particular warning issued is changed into an error by the warnings filter see above." I think "see above" should be enclosed in brackets (or maybe completely removed as there is already a "(see above)" in the same text block). Regards. ---------- assignee: docs@python components: Documentation messages: 333574 nosy: awecx, docs@python, eric.araujo, ezio.melotti, mdk, willingc priority: normal severity: normal status: open title: Typo in library/warnings documentation versions: Python 2.7, Python 3.4, Python 3.5, Python 3.6, Python 3.7, Python 3.8 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35732> _______________________________________
Pablo Galindo Salgado <pablogsal@gmail.com> added the comment: That looks like an error indeed. Are you interested on making a PR for fixing this? ---------- nosy: +pablogsal _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35732> _______________________________________
Antoine Wecxsteen <antoine@wecxsteen.net> added the comment: Hello Pablo, Yes, I'll be happy to make a PR. I don't think it should be removed after all as, actually, the two "see above" do not refer to the same paragraph ("Warning Categories" and "The Warnings Filter" respectively). ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35732> _______________________________________
Change by Antoine Wecxsteen <antoine@wecxsteen.net>: ---------- keywords: +patch pull_requests: +11171 stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35732> _______________________________________
Change by Antoine Wecxsteen <antoine@wecxsteen.net>: ---------- keywords: +patch, patch pull_requests: +11171, 11172 stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35732> _______________________________________
Change by Antoine Wecxsteen <antoine@wecxsteen.net>: ---------- keywords: +patch, patch, patch pull_requests: +11171, 11172, 11173 stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35732> _______________________________________
Change by Antoine Wecxsteen <antoine@wecxsteen.net>: ---------- keywords: +patch, patch, patch, patch pull_requests: +11171, 11172, 11173, 11174 stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35732> _______________________________________
Antoine Wecxsteen <antoine@wecxsteen.net> added the comment: https://github.com/python/cpython/pull/11549 Reading the dev guide, I see there is actually no need to open an issue for mere typos. I should have made a PR directly... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35732> _______________________________________
Change by Cheryl Sabella <cheryl.sabella@gmail.com>: ---------- resolution: -> duplicate stage: patch review -> resolved status: open -> closed superseder: -> Doc: warnings.rst - add links to references _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35732> _______________________________________
Cheryl Sabella <cheryl.sabella@gmail.com> added the comment: Closing as a duplicate of #35563, which converts the 'see above' to links. ---------- nosy: +cheryl.sabella _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35732> _______________________________________
participants (3)
-
Antoine Wecxsteen -
Cheryl Sabella
-
Pablo Galindo Salgado