[issue29062] Documentation link error
New submission from Frank Millman: If you call up online documentation for Python3.6, and select modules>h>hashlib, it takes you to 15.2. hashlib — BLAKE2 hash functions It should take you to 15.1. hashlib — Secure hashes and message digests ---------- assignee: docs@python components: Documentation messages: 283930 nosy: docs@python, frankmillman priority: normal severity: normal status: open title: Documentation link error type: behavior versions: Python 3.6 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Changes by Serhiy Storchaka <storchaka+cpython@gmail.com>: ---------- nosy: +christian.heimes, georg.brandl, gregory.p.smith title: Documentation link error -> hashlib documentation link error versions: +Python 3.7 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Xiang Zhang added the comment: Is the https://docs.python.org/3/library/crypto.html section messed up? Two hashlib entries and some other bad entries? ---------- nosy: +xiang.zhang _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
INADA Naoki added the comment: 1. remove `.. module:: hashlib` from Doc/library/hashlib-blake2.rst 2. merge Doc/library/hashlib-blake2.rst content into Doc/library/hashlib.rst Hmm, which is better? ---------- nosy: +inada.naoki _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Serhiy Storchaka added the comment: Replace ".. module" with ".. currentmodule". ---------- nosy: +serhiy.storchaka _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
INADA Naoki added the comment: I like currentmodule directive. ---------- keywords: +patch Added file: http://bugs.python.org/file46040/29062-currentmodule.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Serhiy Storchaka added the comment: I didn't tested my suggestion. If it solves the issue and makes all related references correct, feel free to push the patch Inada. ---------- assignee: docs@python -> inada.naoki stage: -> commit review _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Roundup Robot added the comment: New changeset 1970c9ea8572 by INADA Naoki in branch 'default': Issue #29062: doc: Fix hashlib module index conflict https://hg.python.org/cpython/rev/1970c9ea8572 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Changes by INADA Naoki <songofacandy@gmail.com>: ---------- resolution: -> fixed stage: commit review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Xiang Zhang added the comment: This fixed the index. But the section is still messed up: https://docs.python.org/3/library/crypto.html. The three entries: Module, Examples, Credits in my mind should not appear on the index. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Roundup Robot added the comment: New changeset c75ef013bca3 by INADA Naoki in branch 'default': Issue #29062: doc: Fix heading level of hashlib-blake2 https://hg.python.org/cpython/rev/c75ef013bca3 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
INADA Naoki added the comment: While section level of Module, Examples, and Credits is fixed, https://docs.python.org/3/library/crypto.html seems still weird. It looks like there are two `hashlib` modules. Now I think hashlib-blake2 should be merged into hashlib. ---------- resolution: fixed -> stage: resolved -> status: closed -> open _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Xiang Zhang added the comment:
Now I think hashlib-blake2 should be merged into hashlib.
+1 INADA, 3.6 branch also suffers the problems here, I didn't see you patch it. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Serhiy Storchaka added the comment:
While section level of Module, Examples, and Credits is fixed, https://docs.python.org/3/library/crypto.html seems still weird. It looks like there are two `hashlib` modules.
That is because hashlib-blake2.rst is explicitly added to the TOC list in Doc/library/crypto.rst. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
INADA Naoki added the comment:
That is because hashlib-blake2.rst is explicitly added to the TOC list in Doc/library/crypto.rst.
Yes. All rst should be explicitly added by `toctree` or `include`. In this case, I feel there are no reason to use `include` directive instead of merging two files. Another option is adding `toctree` directive in `hashlib.rst`. But it means we should organize to use sub toctree, like Doc/library/asyncio.rst. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
INADA Naoki added the comment:
INADA, 3.6 branch also suffers the problems here, I didn't see you patch it.
Oh, I'm sorry. I'll update 3.6 branch in next time. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Changes by INADA Naoki <songofacandy@gmail.com>: Added file: http://bugs.python.org/file46051/merge-hashlib-blake2.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
INADA Naoki added the comment: May I commit merge-hashlib-blake2.patch to 3.6 branch? ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Changes by Serhiy Storchaka <storchaka+cpython@gmail.com>: ---------- nosy: +martin.panter, r.david.murray _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
INADA Naoki added the comment: @christian.heimes Would you look merge-hashlib-blake2.patch? This is blocker of our document translation project. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Xiang Zhang added the comment: Although I am +1 for merging it before but these days I find it's not the only case. There are also two unittest.mock entries. This is just FYI, no opinion on this issue. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Christian Heimes added the comment: Go ahead if it makes your work easier. I kept the file separate because the blake2 documentation is maintained externally. It's not going to change any time soon, though. Let's merge it. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Roundup Robot added the comment: New changeset 799ed3122456 by INADA Naoki in branch '3.6': Issue #29062: Merge hashlib-blake2.rst into hashlib.rst https://hg.python.org/cpython/rev/799ed3122456 New changeset 380e63b7fc82 by INADA Naoki in branch 'default': Issue #29062: Merge hashlib-blake2.rst into hashlib.rst https://hg.python.org/cpython/rev/380e63b7fc82 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
INADA Naoki added the comment: Thanks. ---------- resolution: -> fixed stage: -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Martin Panter added the comment: Looks like Doc/tools/susp-ignored.csv needs updating: $ make -C Doc/ suspicious [. . .] writing output... [ 49%] library/hashlib WARNING: [library/hashlib:502] ":vatrogasac" found in ">>> cookie = b'user:vatrogasac'" WARNING: [library/hashlib:502] ":vatrogasac" found in "user:vatrogasac,349cf904533767ed2d755279a8df84d0" WARNING: [library/hashlib:502] ":policajac" found in ">>> compare_digest(b'user:policajac', sig)" WARNING: [library/hashlib:646] ":LEAF" found in "... h00 = blake2b(buf[0:LEAF_SIZE], fanout=FANOUT, depth=DEPTH," [. . .] WARNING: Found 4/327 unused rules: library/hashlib-blake2,,:vatrogasac,>>> cookie = b'user:vatrogasac' library/hashlib-blake2,,:vatrogasac,user:vatrogasac,349cf904533767ed2d755279a8df84d0 library/hashlib-blake2,,:policajac,>>> compare_digest(b'user:policajac', sig) library/hashlib-blake2,,:LEAF,h00 = blake2b(buf[0:LEAF_SIZE], fanout=FANOUT, depth=DEPTH, build finished with problems, 7 warnings. make[1]: *** [build] Error 1 make[1]: Leaving directory `/media/disk/home/proj/python/cpython/Doc' Suspicious check complete; look for any errors in the above output or in build/suspicious/suspicious.csv. If all issues are false positives, append that file to tools/susp-ignored.csv. make: *** [suspicious] Error 1 ---------- status: closed -> open _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Roundup Robot added the comment: New changeset ea0c488b9bac by INADA Naoki in branch '3.6': Issue #29062: Doc: Fix make suspicious https://hg.python.org/cpython/rev/ea0c488b9bac New changeset 5c48fbe12cb8 by INADA Naoki in branch 'default': Issue #29062: Doc: Fix make suspicious https://hg.python.org/cpython/rev/5c48fbe12cb8 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
INADA Naoki added the comment: Martin, thank you for pointing it out. I hadn't know about suspicious check. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
Changes by INADA Naoki <songofacandy@gmail.com>: ---------- status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29062> _______________________________________
participants (7)
-
Christian Heimes
-
Frank Millman
-
INADA Naoki
-
Martin Panter
-
Roundup Robot
-
Serhiy Storchaka
-
Xiang Zhang