python / python/cpython

Document the ABCs for instance/subclass checks of dict view types

Ouverte
#71,731 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

3.11 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 27544
Nosy @terryjreedy, @Vgr255, @story645, @jnmclarty
Files
  • dict_view_doc_1.patch
  • 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 2016-07-18.01:25:15.883>
    labels = ['3.11', 'type-feature', 'docs']
    title = 'Document the ABCs for instance/subclass checks of dict view types'
    updated_at = <Date 2021-10-21.23:51:52.797>
    user = 'https://github.com/story645'
    

    bugs.python.org fields:

    activity = <Date 2021-10-21.23:51:52.797>
    actor = 'iritkatriel'
    assignee = 'docs@python'
    closed = False
    closed_date = None
    closer = None
    components = ['Documentation']
    creation = <Date 2016-07-18.01:25:15.883>
    creator = 'story645'
    dependencies = []
    files = ['43768']
    hgrepos = []
    issue_num = 27544
    keywords = ['patch']
    message_count = 3.0
    messages = ['270672', '270674', '271029']
    nosy_count = 5.0
    nosy_names = ['terry.reedy', 'docs@python', 'abarry', 'story645', 'Jeffrey McLarty']
    pr_nums = []
    priority = 'normal'
    resolution = None
    stage = 'patch review'
    status = 'open'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue27544'
    versions = ['Python 3.11']
    

    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 examiner le dict_view_doc_1.patch lié ainsi que la documentation Python existante pour les types de vues de dict. Confirmez quels ABCs doivent être documentés pour les vérifications d’instances et de sous-classes, puis vérifiez que la documentation reflète correctement le comportement pris en charge.

    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
    35/100

    Recevez les nouvelles issues par e-mail

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