More documentation for methods in RDoc
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, tooling
Piste de recherche
Commencez par lib/rdoc/parser.rb autour de la ligne 254 et examinez les paramètres des méthodes ainsi que le style existant des commentaires RDoc. Le périmètre de l’issue doit être réduit ; sa réalisation consisterait à ajouter des commentaires cohérents au format RDoc pour un ensemble convenu de méthodes, les annotations de type éventuelles étant traitées comme une décision distincte.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Problem
When I look into a source code of RDoc to debug, it's so hard to read it due to the lack of proper documentation.
For example, https://github.com/ruby/rdoc/blob/master/lib/rdoc/parser.rb#L254 has 5 parameters and I don't know what content is at all. And options is usually a Hash in other gems, but here RDoc::Options instance is expected.
While we can guess some of them, it's not ideal.
Suggestion
My proposal is to add more comments to existing source code of RDoc. This will help us read it better, understand it better and improve it better.
I'd appreciate it if current maintainers do this since they understand the structure of the code well, I could do this as well.
Misc
The documentation format will be RDoc format.
Other ideas
Or, it might be worth adding types to RDoc.
- Langage dominant
- Ruby
- Étoiles
- 928
- Forks
- 471
- Merge moyen
- 2 j 4 min
- PR mergées (30 j)
- 13
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de ruby/rdoc
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationPeut-être pris @OskarEichler l’a pris il y a 66 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
ruby/rdoc#1759 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
markdown html excerpt includes link partsPeut-être pris @anyingiit l’a pris il y a 12 jours. Ouverte
Difficulté 3/5 1-2 jours Accessibilité débutants 66/100
Les mainteneurs répondent en général sous 1 jour
-
Regexp generated from unescaped input in #expand_classPeut-être pris @jaynetics l’a pris il y a 24 jours. Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 25/100
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de ruby/rdoc
Issues similaires
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
Les mainteneurs répondent en général sous 1 jour
-
👩💻 équipe CE fonctionnalité
Difficulté 2/5 1-3 heures Accessibilité débutants 63/100
betagouv/conseillers-entreprises#4779 ·
Les mainteneurs répondent en général sous 1 jour
-
resource: surah-info
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
TarteelAI/quranic-universal-library#996 ·
Les mainteneurs répondent en général sous 1 jour
-
Missing ar translation: components/common/CommunitySolution.tsx:communitySolution.authorsSolutionOuverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
swombat/souls-house#770 ·
Les mainteneurs répondent en général sous 1 jour