python / python/cpython

Insufficient description of relative imports in docs.python.org

Ouverte
#82,690 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

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

Description

BPO 38509
Nosy @anirudnits

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-10-17.16:38:32.264>
labels = ['type-bug', 'docs']
title = 'Insufficient description of relative imports in docs.python.org'
updated_at = <Date 2019-10-17.16:38:32.264>
user = 'https://github.com/anirudnits'

bugs.python.org fields:

activity = <Date 2019-10-17.16:38:32.264>
actor = 'Aniruddha Bhattacharjee'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-10-17.16:38:32.264>
creator = 'Aniruddha Bhattacharjee'
dependencies = []
files = []
hgrepos = []
issue_num = 38509
keywords = []
message_count = 1.0
messages = ['354851']
nosy_count = 2.0
nosy_names = ['docs@python', 'Aniruddha Bhattacharjee']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue38509'
versions = ['Python 3.6']

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

Commencez par la documentation sur les imports relatifs sur docs.python.org et examinez le contexte de l’issue BPO 38509. Identifiez l’explication qui manque aux débutants et mettez à jour la documentation concernée afin que les imports relatifs y soient décrits de manière suffisamment complète et exacte.

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

Recevez les nouvelles issues par e-mail

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