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

Ouverte
#1,627 4 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

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

Piste de recherche

Le payload ne mentionne aucun fichier ni test du dépôt ; commencez par localiser le guide de style de la documentation de devguide et ses recommandations concernant les exemples de code de Tutorial. Lisez l’issue BPO liée pour comprendre la distinction prévue, puis mettez à jour la documentation concernée afin que les exemples de Tutorial soient clairement traités séparément des autres documents.

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

Description

needs: decision topic-documentation type-feature
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']

Langage dominant
Python
Étoiles
2.1k
Forks
1k
Merge moyen
2 j 12 h
PR mergées (30 j)
12

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.

Autres issues de python/devguide

Toutes les issues de python/devguide

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

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