python / python/devguide

Docs style guide: Code Examples, distinguish between the Tutorial and other documentation

Aperta
#1,627 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

needs: decision topic-documentation type-feature
Lingua principale
Python
Stelle
2.1k
Fork
1k
Merge medio
2g 12h
PR unite (30g)
12

Descrizione

BPO 40758
Nosy @rhettinger, @ChasBelov

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-05-24.20:49:25.128>
labels = ['3.8', '3.9', '3.10', 'docs']
title = 'For 7.2.7. Code Examples, distinguish between the Tutorial and other documentation'
updated_at = <Date 2021-03-26.03:23:38.984>
user = 'https://github.com/ChasBelov'

bugs.python.org fields:

activity = <Date 2021-03-26.03:23:38.984>
actor = 'rhettinger'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-05-24.20:49:25.128>
creator = 'Chas Belov'
dependencies = []
files = []
hgrepos = []
issue_num = 40758
keywords = []
message_count = 2.0
messages = ['369825', '389537']
nosy_count = 3.0
nosy_names = ['rhettinger', 'docs@python', 'Chas Belov']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue40758'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Il payload non indica alcun file né test del repository; inizia individuando la guida allo stile della documentazione di devguide e le relative indicazioni per gli esempi di codice di Tutorial. Leggi l’issue BPO collegata per la distinzione prevista, quindi aggiorna la documentazione pertinente in modo che gli esempi di Tutorial siano chiaramente trattati separatamente dal resto della documentazione.

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

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.