python / python/cpython

Make documentation of * in function signatures easier to find

Ouverte
#86,737 7 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

3.10 3.8 (EOL) 3.9 (EOL) docs type-feature
Langage dominant
Python
Étoiles
77.2k
Forks
36k
Merge moyen
1 j 9 h
PR mergées (30 j)
558

Description

BPO 42571
Nosy @merwok, @fredg1

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 2020-12-04.21:11:08.529>
labels = ['type-feature', '3.8', '3.9', '3.10', 'docs']
title = 'Make documentation of * in function signatures easier to find'
updated_at = <Date 2020-12-14.14:34:02.476>
user = 'https://github.com/fredg1'

bugs.python.org fields:

activity = <Date 2020-12-14.14:34:02.476>
actor = 'eric.araujo'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-12-04.21:11:08.529>
creator = 'fredg1'
dependencies = []
files = []
hgrepos = []
issue_num = 42571
keywords = []
message_count = 5.0
messages = ['382530', '382876', '382965', '382966', '382989']
nosy_count = 3.0
nosy_names = ['eric.araujo', 'docs@python', 'fredg1']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue42571'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

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

L’issue ne nomme aucun fichier de documentation ni aucun test. Commencez par trouver la documentation de CPython sur les signatures de fonctions et l’explication existante de * ; le travail est terminé lorsque les lecteurs peuvent trouver et comprendre comment * est documenté dans les signatures.

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

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

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