`socket.AddressFamily` and `socket.SocketKind` are undocumented
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 77.2k
- Forks
- 35.9k
- Métriques de merge des PR
- Métriques de PR en attente
Description
Documentation
The socket.AddressFamily and socket.SocketKind values are not documented. As a result, (inter)Sphinx can generate mappings to it. This is visible in the official documentation at socket constants and in my project at wakeonlan.send_magic_packet.
It looks like this was previously reported in #64888, and some fixes are linked in https://github.com/python/cpython/issues/64888#issuecomment-1093646909. However, the documentation is still absent.
Linked PRs
- gh-151495
- gh-153286
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la section consacrée aux constantes de socket dans la documentation officielle et examinez la discussion précédente dans l’issue #64888, y compris les correctifs associés. Vérifiez comment socket.AddressFamily et socket.SocketKind y sont exposés et ce que couvrent déjà les PR associés. Le travail est terminé lorsque les deux valeurs sont documentées et que les mappages Sphinx se résolvent correctement.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 30/100