python / python/cpython

SocketType documentation misleading

Ouverte
#88,427 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

docs extension-modules topic-socket type-feature
Langage dominant
Python
Étoiles
77.2k
Forks
36k
Métriques de merge des PR
Métriques de PR en attente

Description

BPO 44261
Nosy @srittau, @JelleZijlstra

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2021-05-28.15:21:42.596>
labels = ['docs']
title = 'SocketType documentation misleading'
updated_at = <Date 2021-05-29.23:00:46.252>
user = 'https://github.com/srittau'

bugs.python.org fields:

activity = <Date 2021-05-29.23:00:46.252>
actor = 'JelleZijlstra'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-05-28.15:21:42.596>
creator = 'srittau'
dependencies = []
files = []
hgrepos = []
issue_num = 44261
keywords = []
message_count = 2.0
messages = ['394665', '394743']
nosy_count = 3.0
nosy_names = ['srittau', 'docs@python', 'JelleZijlstra']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue44261'
versions = []

Linked PRs
  • gh-126272

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 examiner la documentation de SocketType et la PR liée gh-126272, puis comparez la formulation actuelle avec le comportement documenté. Le travail est considéré comme terminé lorsque la documentation trompeuse est clarifiée et que les vérifications pertinentes de la documentation réussissent.

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é
À clarifier
Accessibilité débutants
20/100

Recevez les nouvelles issues par e-mail

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