python / python/cpython

Cover directory and zipfile execution in __main__ module docs

Ouverte
#89,312 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

docs type-feature
Langage dominant
Python
Étoiles
77.2k
Forks
36k
Métriques de merge des PR
Métriques de PR en attente

Description

BPO 45149
Nosy @ncoghlan

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 2021-09-09.07:45:42.475>
labels = ['type-feature', 'docs']
title = 'Cover directory and zipfile execution in __main__ module docs'
updated_at = <Date 2022-03-11.14:52:45.711>
user = 'https://github.com/ncoghlan'

bugs.python.org fields:

activity = <Date 2022-03-11.14:52:45.711>
actor = 'petr.viktorin'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-09-09.07:45:42.475>
creator = 'ncoghlan'
dependencies = []
files = []
hgrepos = []
issue_num = 45149
keywords = []
message_count = 1.0
messages = ['401440']
nosy_count = 2.0
nosy_names = ['ncoghlan', 'docs@python']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue45149'
versions = []

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

Repérez la documentation du module main et examinez comment l’exécution depuis des répertoires et des fichiers zip est actuellement décrite. Mettez à jour la documentation pour couvrir les deux formes d’exécution, puis vérifiez que le texte obtenu les explique clairement ; aucun fichier ni test précis n’est indiqué dans l’issue.

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é
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

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