Incorrect documentation for BlameHunk

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

Personne n'a encore pris cette issue.

Évaluation

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

Piste de recherche

Commencez par la documentation de BlameHunk à l’adresse https://www.nodegit.org/api/blame_hunk/ et suivez la manière dont sa documentation d’API est générée. Vérifiez si la même classification concerne d’autres objets documentés, puis mettez à jour le générateur ou la source de documentation afin que les champs renvoyant des fonctions soient répertoriés comme des méthodes de classe, et vérifiez les pages concernées.

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

Description

The documentation for BlameHunk at https://www.nodegit.org/api/blame_hunk/ lists all fields as "instance variables".

None of them are instance variables of the specified type. All of them are functions returning the specified type.

The documentation should list them as class methods.

There are a number of other objects besides BlameHunk that have this same error, so I'm presuming it's a consequence of how the documentation is generated.

Langage dominant
JavaScript
Étoiles
5.8k
Forks
704
Aucune PR mergée en 30 j

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 nodegit/nodegit

Toutes les issues de nodegit/nodegit

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

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