Intra-package References Documentation Incomplete

Descrizione

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']

Come iniziare

Leggi tutta la issue e poi la guida ai contributi del progetto.

Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.

Fai un fork del repository e lavora su un branch.

Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia leggendo l’issue BPO 35927 collegata e ispezionando sound.zip, l’esempio di codice copiato dalla documentazione. Identifica quali riferimenti intra-package mancano o sono incompleti nella documentazione Python pertinente. Il lavoro è completato quando la documentazione copre completamente i riferimenti dimostrati dall’esempio e i controlli appropriati della documentazione hanno esito positivo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico

python

Ambito

documentation

Tipo di issue

Documentazione

Difficoltà

3/5

Tempo stimato

1-2 giorni

Stato di attività

Ferma

Chiarezza

Da chiarire

Idoneità per principianti

35/100

Descrizione

Guida per i contributori

Come iniziare

Direzione di ricerca

Valutazione

Ricevi le nuove issue nella tua casella