The documentation for the bundled gem has not been updated

Ouverte
#2,258 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
25/100
Type d'issue
Documentation
Clarté
À clarifier
Activité
À l'abandon
Stack technique
ruby
Domaine
documentation

Piste de recherche

Commencez par la tâche d’annotation de rake et par la façon dont elle collecte la documentation RBS depuis l’arbre des sources de ruby/ruby. Examinez la manière dont les gems incluses sont représentées et décidez quelle approche documentaire devrait les couvrir. Le travail est considéré comme terminé lorsqu’une approche approuvée et un workflow de documentation mis à jour pour les gems incluses sont définis.

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

Description

The rake annotation task generates documentation for RBS from the ruby/ruby source code. However, bundled gems are not included in the ruby/ruby source code. As a result, the rake annotate task that updates documentation does not update the documentation for bundled gems.

I think we need to decide on how to approach the documentation for bundled gems.

  • minitest
  • net-smtp
  • base64
  • bigdecimal
  • abbrev
  • nkf
  • csv
  • observer
Langage dominant
Ruby
Étoiles
2.2k
Forks
263
Merge moyen
1 j 20 h
PR mergées (30 j)
64

Préparer son environnement

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 ruby/rbs

Toutes les issues de ruby/rbs

Issues similaires

Plus d'issues Ruby

Recevez les nouvelles issues par e-mail

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