Intra-package References Documentation Incomplete

Description

BPO	35927
Nosy	@brettcannon, @terryjreedy, @ncoghlan, @ericsnowcurrently
Files	sound.zip: zip of code sample copied from documentation

^{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 2019-02-07.04:38:30.393>
labels = ['3.8', 'type-bug', '3.7', 'docs']
title = 'Intra-package References Documentation Incomplete'
updated_at = <Date 2019-02-14.00:38:19.737>
user = 'https://bugs.python.org/ADataGman'

bugs.python.org fields:

activity = <Date 2019-02-14.00:38:19.737>
actor = 'ADataGman'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-02-07.04:38:30.393>
creator = 'ADataGman'
dependencies = []
files = ['48109']
hgrepos = []
issue_num = 35927
keywords = []
message_count = 7.0
messages = ['335002', '335104', '335105', '335126', '335303', '335385', '335486']
nosy_count = 6.0
nosy_names = ['brett.cannon', 'terry.reedy', 'ncoghlan', 'docs@python', 'eric.snow', 'ADataGman']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue35927'
versions = ['Python 3.7', 'Python 3.8']

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 lire l’issue BPO 35927 liée et inspectez sound.zip, l’exemple de code copié de la documentation. Identifiez les références intra-package manquantes ou incomplètes dans la documentation Python concernée. Le travail est terminé lorsque la documentation couvre entièrement les références illustrées par l’exemple et que les vérifications de documentation appropriées passent.

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é

3/5

Temps estimé

1-2 jours

Activité

À l'abandon

Clarté

À clarifier

Accessibilité débutants

35/100

Description

Guide de contribution

Par où commencer

Piste de recherche

Évaluation

Recevez les nouvelles issues par e-mail