python / python/cpython

Fix Sphinx reference warnings in various `Doc/library/` files

Ouverte
#151,950 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

docs type-bug
Langage dominant
Python
Étoiles
77.2k
Forks
35.9k
Métriques de merge des PR
Métriques de PR en attente

Description

Bug report

[!IMPORTANT]
See the meta issue for more information.

Doc/library/ast.rst
Doc/library/ast.rst:50: py:class reference target not found: ast.stmt [ref.class]
Doc/library/ast.rst:50: py:class reference target not found: ast.expr [ref.class]
Doc/library/ast.rst:66: py:attr reference target not found: left [ref.attr]
Doc/library/ast.rst:66: py:class reference target not found: ast.expr [ref.class]
Doc/library/ast.rst:93: py:class reference target not found: ast.expr [ref.class]
Doc/library/ast.rst:93: py:class reference target not found: ast.stmt [ref.class]
Doc/library/ast.rst:107: py:class reference target not found: ast.T [ref.class]
Doc/library/ast.rst:109: py:attr reference target not found: T._fields [ref.attr]
Doc/library/ast.rst:2221: py:class reference target not found: ast.operator [ref.class]
Doc/library/ast.rst:2221: py:class reference target not found: ast.unaryop [ref.class]
Doc/library/ast.rst:2221: py:class reference target not found: ast.cmpop [ref.class]
Doc/library/ast.rst:2221: py:class reference target not found: ast.boolop [ref.class]
Doc/library/ast.rst:2221: py:class reference target not found: ast.expr_context [ref.class]
Doc/library/asyncio-extending.rst
Doc/library/asyncio-extending.rst:24: py:class reference target not found: asyncio.BaseEventLoop [ref.class]
Doc/library/asyncio-extending.rst:27: py:class reference target not found: asyncio.BaseEventLoop [ref.class]
Doc/library/importlib.rst
Doc/library/importlib.rst:357: py:meth reference target not found: get_resource_reader [ref.meth]
Doc/library/importlib.rst:362: py:meth reference target not found: get_resource_reader [ref.meth]
Doc/library/importlib.rst:719: py:meth reference target not found: Loader.create_module [ref.meth]
Doc/library/importlib.rst:719: py:meth reference target not found: Loader.exec_module [ref.meth]
Doc/library/importlib.rst:733: py:meth reference target not found: Loader.create_module [ref.meth]
Doc/library/importlib.rst:733: py:meth reference target not found: Loader.exec_module [ref.meth]
Doc/library/importlib.rst:1179: py:func reference target not found: get_tag [ref.func]
Doc/library/importlib.rst:1179: py:attr reference target not found: sys.implementation.cache_tag [ref.attr]
Doc/library/importlib.rst:1211: py:attr reference target not found: sys.implementation.cache_tag [ref.attr]
Doc/library/importlib.rst:1266: py:func reference target not found: import_module [ref.func]
Doc/library/importlib.rst:1293: py:meth reference target not found: InspectLoader.is_package [ref.meth]
Doc/library/mmap.rst
Doc/library/mmap.rst:11: py:meth reference target not found: seek [ref.meth]
Doc/library/mmap.rst:33: py:const reference target not found: ACCESS_READ [ref.const]
Doc/library/mmap.rst:33: py:const reference target not found: ACCESS_WRITE [ref.const]
Doc/library/mmap.rst:33: py:const reference target not found: ACCESS_COPY [ref.const]
Doc/library/mmap.rst:33: py:const reference target not found: ACCESS_DEFAULT [ref.const]
Doc/library/mmap.rst:47: py:const reference target not found: ACCESS_DEFAULT [ref.const]
Doc/library/mmap.rst:69: py:const reference target not found: ALLOCATIONGRANULARITY [ref.const]
Doc/library/mmap.rst:103: py:const reference target not found: PROT_READ [ref.const]
Doc/library/mmap.rst:103: py:const reference target not found: PROT_WRITE [ref.const]
Doc/library/mmap.rst:103: py:const reference target not found: PROT_READ | PROT_WRITE [ref.const]
Doc/library/mmap.rst:113: py:const reference target not found: ALLOCATIONGRANULARITY [ref.const]
Doc/library/mmap.rst:113: py:const reference target not found: PAGESIZE [ref.const]
Doc/library/mmap.rst:217: py:const reference target not found: PAGESIZE [ref.const]
Doc/library/mmap.rst:217: py:const reference target not found: ALLOCATIONGRANULARITY [ref.const]
Doc/library/mmap.rst:250: py:const reference target not found: PAGESIZE [ref.const]
Doc/library/mmap.rst:264: py:const reference target not found: ACCESS_READ [ref.const]
Doc/library/mmap.rst:297: py:const reference target not found: ACCESS_READ [ref.const]
Doc/library/mmap.rst:297: py:const reference target not found: ACCESS_COPY [ref.const]
Doc/library/mmap.rst:368: py:const reference target not found: ACCESS_READ [ref.const]
Doc/library/mmap.rst:384: py:const reference target not found: ACCESS_READ [ref.const]
Doc/library/multiprocessing.rst
Doc/library/multiprocessing.rst:302: py:meth reference target not found: Connection.send [ref.meth]
Doc/library/multiprocessing.rst:302: py:meth reference target not found: Connection.recv [ref.meth]
Doc/library/multiprocessing.rst:310: py:meth reference target not found: Connection.send [ref.meth]
Doc/library/multiprocessing.rst:310: py:meth reference target not found: Connection.recv [ref.meth]
Doc/library/multiprocessing.rst:812: py:meth reference target not found: Connection.recv_bytes_into [ref.meth]
Doc/library/multiprocessing.rst:919: py:meth reference target not found: multiprocessing.Connection.send [ref.meth]
Doc/library/multiprocessing.rst:919: py:meth reference target not found: multiprocessing.Connection.recv [ref.meth]
Doc/library/multiprocessing.rst:1245: py:class reference target not found: Pool [ref.class]
Doc/library/multiprocessing.rst:1377: py:exc reference target not found: BufferTooShort [ref.exc]
Doc/library/multiprocessing.rst:1418: py:func reference target not found: Pipe [ref.func]
Doc/library/multiprocessing.rst:1657: py:mod reference target not found: multiprocessing.synchronize [ref.mod]
Doc/library/multiprocessing.rst:1835: py:meth reference target not found: get_obj [ref.meth]
Doc/library/multiprocessing.rst:1835: py:meth reference target not found: get_lock [ref.meth]
Doc/library/multiprocessing.rst:1971: py:class reference target not found: Server [ref.class]
Doc/library/multiprocessing.rst:1971: py:meth reference target not found: serve_forever [ref.meth]
Doc/library/multiprocessing.rst:1980: py:class reference target not found: Server [ref.class]
Doc/library/multiprocessing.rst:2015: py:attr reference target not found: proxytype._exposed_ [ref.attr]
Doc/library/multiprocessing.rst:2024: py:attr reference target not found: proxytype._method_to_typeid_ [ref.attr]
Doc/library/multiprocessing.rst:2370: py:exc reference target not found: RemoteError [ref.exc]
Doc/library/multiprocessing.rst:2443: py:func reference target not found: multiprocessing.Pool [ref.func]
Doc/library/multiprocessing.rst:2443: py:func reference target not found: get_context [ref.func]
Doc/library/multiprocessing.rst:3173: py:meth reference target not found: multiprocessing.Process._bootstrap [ref.meth]
Doc/library/optparse.rst
Doc/library/optparse.rst:564: py:meth reference target not found: set_defaults [ref.meth]
Doc/library/optparse.rst:603: py:meth reference target not found: parser.print_help [ref.meth]
Doc/library/optparse.rst:685: py:class reference target not found: OptionContainer [ref.class]
Doc/library/optparse.rst:685: py:meth reference target not found: add_option [ref.meth]
Doc/library/optparse.rst:689: py:meth reference target not found: add_option_group [ref.meth]
Doc/library/optparse.rst:825: py:func reference target not found: OptionParser.error [ref.func]
Doc/library/optparse.rst:861: py:func reference target not found: OptionParser.error [ref.func]
Doc/library/optparse.rst:865: py:meth reference target not found: OptionParser.exit [ref.meth]
Doc/library/optparse.rst:865: py:meth reference target not found: OptionParser.error [ref.meth]
Doc/library/optparse.rst:920: py:const reference target not found: optparse.SUPPRESS_USAGE [ref.const]
Doc/library/optparse.rst:953: py:class reference target not found: IndentedHelpFormatter [ref.class]
Doc/library/optparse.rst:974: py:meth reference target not found: add_option [ref.meth]
Doc/library/optparse.rst:978: py:func reference target not found: make_option [ref.func]
Doc/library/optparse.rst:980: py:func reference target not found: make_option [ref.func]
Doc/library/optparse.rst:995: py:func reference target not found: make_option [ref.func]
Doc/library/optparse.rst:1010: py:meth reference target not found: add_option [ref.meth]
Doc/library/optparse.rst:1187: py:const reference target not found: optparse.SUPPRESS_HELP [ref.const]
Doc/library/optparse.rst:1360: py:const reference target not found: optparse.SUPPRESS_HELP [ref.const]
Doc/library/optparse.rst:1438: py:func reference target not found: optparse.check_choice [ref.func]
Doc/library/optparse.rst:1481: py:meth reference target not found: error [ref.meth]
Doc/library/optparse.rst:1614: py:meth reference target not found: OptionParser.destroy [ref.meth]
Doc/library/optparse.rst:1631: py:const reference target not found: optparse.SUPPRESS_USAGE [ref.const]
Doc/library/optparse.rst:2007: py:meth reference target not found: error [ref.meth]
Doc/library/optparse.rst:2052: py:meth reference target not found: add_option [ref.meth]
Doc/library/optparse.rst:2105: py:meth reference target not found: take_action [ref.meth]
Doc/library/optparse.rst:2148: py:meth reference target not found: MyOption.take_action [ref.meth]
Doc/library/optparse.rst:2148: py:meth reference target not found: Option.take_action [ref.meth]
Doc/library/optparse.rst:2152: py:meth reference target not found: ensure_value [ref.meth]
Doc/library/optparse.rst:2158: py:meth reference target not found: ensure_value [ref.meth]
Doc/library/pickletools.rst
Doc/library/pickletools.rst:109: py:class reference target not found: OpcodeInfo [ref.class]
Doc/library/socket.rst
Doc/library/socket.rst:24: py:meth reference target not found: read [ref.meth]
Doc/library/socket.rst:24: py:meth reference target not found: write [ref.meth]
Doc/library/socket.rst:78: py:const reference target not found: INADDR_ANY [ref.const]
Doc/library/socket.rst:78: py:const reference target not found: INADDR_BROADCAST [ref.const]
Doc/library/socket.rst:85: py:const reference target not found: struct sockaddr_in6 [ref.const]
Doc/library/socket.rst:97: py:const reference target not found: AF_NETLINK [ref.const]
Doc/library/socket.rst:99: py:const reference target not found: AF_TIPC [ref.const]
Doc/library/socket.rst:105: py:const reference target not found: TIPC_ADDR_NAMESEQ [ref.const]
Doc/library/socket.rst:105: py:const reference target not found: TIPC_ADDR_NAME [ref.const]
Doc/library/socket.rst:105: py:const reference target not found: TIPC_ADDR_ID [ref.const]
Doc/library/socket.rst:107: py:const reference target not found: TIPC_ZONE_SCOPE [ref.const]
Doc/library/socket.rst:107: py:const reference target not found: TIPC_CLUSTER_SCOPE [ref.const]
Doc/library/socket.rst:107: py:const reference target not found: TIPC_NODE_SCOPE [ref.const]
Doc/library/socket.rst:109: py:const reference target not found: TIPC_ADDR_NAME [ref.const]
Doc/library/socket.rst:112: py:const reference target not found: TIPC_ADDR_NAMESEQ [ref.const]
Doc/library/socket.rst:115: py:const reference target not found: TIPC_ADDR_ID [ref.const]
Doc/library/socket.rst:131: py:const reference target not found: SYSPROTO_CONTROL [ref.const]
Doc/library/socket.rst:131: py:const reference target not found: PF_SYSTEM [ref.const]
Doc/library/socket.rst:247: py:const reference target not found: IPPROTO_UDPLITE [ref.const]
Doc/library/socket.rst:323: c:func reference target not found: hstrerror [ref.func]
Doc/library/socket.rst:336: c:func reference target not found: gai_strerror [ref.func]
Doc/library/socket.rst:367: py:class reference target not found: AddressFamily [ref.class]
Doc/library/socket.rst:367: py:class reference target not found: SocketKind [ref.class]
Doc/library/socket.rst:520: py:data reference target not found: CAN_BCM_CAN_FD_FRAME [ref.data]
Doc/library/socket.rst:779: py:data reference target not found: SO_REUSEPORT [ref.data]
Doc/library/socket.rst:904: py:data reference target not found: SO_REUSEPORT [ref.data]
Doc/library/socket.rst:931: py:data reference target not found: SO_REUSEADDR [ref.data]
Doc/library/socket.rst:1001: py:const reference target not found: AI_NUMERICHOST [ref.const]
Doc/library/socket.rst:1010: py:const reference target not found: AI_CANONNAME [ref.const]
Doc/library/socket.rst:1028: py:data reference target not found: IPPROTO_TCP [ref.data]
Doc/library/socket.rst:1028: py:data reference target not found: IPPROTO_UDP [ref.data]
Doc/library/socket.rst:1449: py:const reference target not found: SCM_RIGHTS [ref.const]
Doc/library/socket.rst:1463: py:const reference target not found: SCM_RIGHTS [ref.const]
Doc/library/socket.rst:1480: py:const reference target not found: CAN_RAW [ref.const]
Doc/library/socket.rst:2386: py:const reference target not found: CAN_RAW [ref.const]
Doc/library/socket.rst:2438: py:const reference target not found: socket.SO_REUSEADDR [ref.const]
Doc/library/socket.rst:2445: py:data reference target not found: SO_REUSEADDR [ref.data]
Doc/library/ssl.rst
Doc/library/ssl.rst:40: py:meth reference target not found: getpeercert [ref.meth]
Doc/library/ssl.rst:40: py:meth reference target not found: cipher [ref.meth]
Doc/library/ssl.rst:40: py:meth reference target not found: get_verified_chain [ref.meth]
Doc/library/ssl.rst:40: py:meth reference target not found: get_unverified_chain [ref.meth]
Doc/library/ssl.rst:203: 'envvar' reference target not found: SSLKEYLOGFILE [ref.envvar]
Doc/library/ssl.rst:443: py:attr reference target not found: cafile [ref.attr]
Doc/library/ssl.rst:444: py:attr reference target not found: capath [ref.attr]
Doc/library/ssl.rst:445: py:attr reference target not found: openssl_cafile_env [ref.attr]
Doc/library/ssl.rst:446: py:attr reference target not found: openssl_cafile [ref.attr]
Doc/library/ssl.rst:447: py:attr reference target not found: openssl_capath_env [ref.attr]
Doc/library/ssl.rst:448: py:attr reference target not found: openssl_capath [ref.attr]
Doc/library/ssl.rst:458: py:const reference target not found: x509_asn [ref.const]
Doc/library/ssl.rst:458: py:const reference target not found: pkcs_7_asn [ref.const]
Doc/library/ssl.rst:481: py:const reference target not found: x509_asn [ref.const]
Doc/library/ssl.rst:481: py:const reference target not found: pkcs_7_asn [ref.const]
Doc/library/ssl.rst:1112: py:meth reference target not found: sendfile [ref.meth]
Doc/library/ssl.rst:1115: py:meth reference target not found: shutdown [ref.meth]
Doc/library/ssl.rst:1159: py:meth reference target not found: SSLSocket.recv [ref.meth]
Doc/library/ssl.rst:1177: py:meth reference target not found: SSLSocket.send [ref.meth]
Doc/library/ssl.rst:1933: py:meth reference target not found: connect [ref.meth]
Doc/library/ssl.rst:1933: py:meth reference target not found: accept [ref.meth]
Doc/library/ssl.rst:1947: py:meth reference target not found: socket.connect [ref.meth]
Doc/library/ssl.rst:1954: py:meth reference target not found: SSLSocket.recv [ref.meth]
Doc/library/ssl.rst:2544: py:meth reference target not found: listen [ref.meth]
Doc/library/ssl.rst:2559: py:meth reference target not found: accept [ref.meth]
Doc/library/ssl.rst:2616: py:meth reference target not found: SSLSocket.recv [ref.meth]
Doc/library/ssl.rst:2616: py:meth reference target not found: SSLSocket.send [ref.meth]
Doc/library/ssl.rst:2623: py:meth reference target not found: SSLSocket.recv [ref.meth]
Doc/library/termios.rst
Doc/library/termios.rst:34: py:const reference target not found: VMIN [ref.const]
Doc/library/termios.rst:34: py:const reference target not found: VTIME [ref.const]
Doc/library/termios.rst:76: py:const reference target not found: TCIFLUSH [ref.const]
Doc/library/termios.rst:76: py:const reference target not found: TCOFLUSH [ref.const]
Doc/library/termios.rst:76: py:const reference target not found: TCIOFLUSH [ref.const]
Doc/library/termios.rst:83: py:const reference target not found: TCOOFF [ref.const]
Doc/library/termios.rst:83: py:const reference target not found: TCOON [ref.const]
Doc/library/termios.rst:83: py:const reference target not found: TCIOFF [ref.const]
Doc/library/termios.rst:83: py:const reference target not found: TCION [ref.const]
Doc/library/termios.rst:90: py:const reference target not found: termios.TIOCGWINSZ [ref.const]
Doc/library/termios.rst:90: py:const reference target not found: termios.TIOCGSIZE [ref.const]
Doc/library/termios.rst:99: py:const reference target not found: termios.TIOCGWINSZ [ref.const]
Doc/library/termios.rst:99: py:const reference target not found: termios.TIOCSWINSZ [ref.const]
Doc/library/termios.rst:99: py:const reference target not found: termios.TIOCGSIZE [ref.const]
Doc/library/termios.rst:99: py:const reference target not found: termios.TIOCSSIZE [ref.const]
Doc/library/test.rst
Doc/library/test.rst:163: py:func reference target not found: test_main [ref.func]
Doc/library/test.rst:396: c:macro reference target not found: WITH_DOC_STRINGS [ref.macro]
Doc/library/test.rst:506: py:const reference target not found: _testcapi.WITH_PYMALLOC [ref.const]
Doc/library/test.rst:1020: py:mod reference target not found: multiprocessing.synchronize [ref.mod]
Doc/library/test.rst:1132: py:const reference target not found: socket.SO_REUSEADDR [ref.const]
Doc/library/test.rst:1132: py:const reference target not found: socket.SO_REUSEPORT [ref.const]
Doc/library/test.rst:1143: py:const reference target not found: socket.SO_EXCLUSIVEADDRUSE [ref.const]
Doc/library/test.rst:1191: 'envvar' reference target not found: PYTHONUSERSITE [ref.envvar]
Doc/library/test.rst:1612: py:func reference target not found: reload [ref.func]
Doc/library/test.rst:1777: py:class reference target not found: WarningRecorder [ref.class]
Doc/library/test.rst:1786: py:meth reference target not found: reset [ref.meth]
Doc/library/wsgiref.rst
Doc/library/wsgiref.rst:161: py:meth reference target not found: read [ref.meth]
Doc/library/wsgiref.rst:169: py:meth reference target not found: close [ref.meth]
Doc/library/wsgiref.rst:221: py:meth reference target not found: keys [ref.meth]
Doc/library/wsgiref.rst:221: py:meth reference target not found: values [ref.meth]
Doc/library/wsgiref.rst:221: py:meth reference target not found: items [ref.meth]
Doc/library/wsgiref.rst:280: py:func reference target not found: shift_path_info [ref.func]
Doc/library/wsgiref.rst:331: py:meth reference target not found: serve_forever [ref.meth]
Doc/library/wsgiref.rst:331: py:meth reference target not found: handle_request [ref.meth]
Doc/library/wsgiref.rst:365: py:attr reference target not found: base_environ [ref.attr]
Doc/library/wsgiref.rst:406: py:mod reference target not found: paste.lint [ref.mod]
Doc/library/wsgiref.rst:528: py:attr reference target not found: stdin [ref.attr]
Doc/library/wsgiref.rst:528: py:attr reference target not found: stdout [ref.attr]
Doc/library/wsgiref.rst:528: py:attr reference target not found: stderr [ref.attr]
Doc/library/wsgiref.rst:528: py:attr reference target not found: environ [ref.attr]
Doc/library/wsgiref.rst:591: py:attr reference target not found: environ [ref.attr]
Doc/library/wsgiref.rst:647: py:func reference target not found: guess_scheme [ref.func]
Doc/library/wsgiref.rst:647: py:attr reference target not found: environ [ref.attr]
Doc/library/wsgiref.rst:655: py:attr reference target not found: environ [ref.attr]
Linked PRs
  • gh-114958
  • gh-151976
  • gh-152209
  • gh-153764
  • gh-153885
  • gh-154498
  • gh-157610
  • gh-157701
  • gh-157702
  • gh-157703

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la meta issue liée et examinez les avertissements de référence Sphinx répertoriés pour les fichiers Doc/library/*.rst, notamment ast.rst, asyncio-extending.rst, importlib.rst, mmap.rst, multiprocessing.rst, optparse.rst, pickletools.rst et socket.rst. Déterminez les modifications nécessaires de la documentation pour chaque cible manquante, puis reconstruisez la documentation et confirmez que ces avertissements de référence sont résolus.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
Active
Clarté
Plutôt claire
Accessibilité débutants
48/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.