How to handle tool-specific magic comments
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 35/100
- Type d'issue
- Bug
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- ruby
- Domaine
- documentation
Piste de recherche
L’issue ne mentionne aucun fichier d’implémentation ni aucun test. Reproduisez l’exemple avec RDoc, puis suivez le traitement des shebangs et des commentaires magiques de Ruby et comparez-le à celui de commentaires spécifiques aux outils tels que # typed: true et # rbs_inline: enabled. C’est terminé lorsque ces commentaires n’apparaissent plus comme documentation de niveau supérieur sans casser le comportement existant de RDoc vis-à-vis des commentaires magiques.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
rdoc currently removes shebangs and ruby magic comments from rendered documetantion.
But other tools like sorbet and rbs-inline provide their own comments like # typed: true or rbs_inline: enabled which aren't excluded. If I have a file like this:
# frozen_string_literal: true
# rbs_inline: enabled
# :markup: markdown
module Prism
module Foo
# ...
end
end
Then for each file, you get one rbs_inline comment on the top-level namespace. I feel like either rdoc should
- ignore any magic-style comment, regardless of if it is "official" or not
- Not attach comments where there is whitespace before the top-level. I guess this is not feasable for backwards compat since rdoc itself makes heavy use of that style.
This can be worked around by inserting #-- before the magic comments but I don't think I should need to care about this at all.
- Langage dominant
- Ruby
- Étoiles
- 928
- Forks
- 470
- Merge moyen
- 1 j 5 h
- PR mergées (30 j)
- 16
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
-
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 57 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 3 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 15 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
-
enhancement
Difficulté 4/5 3-5 jours Accessibilité débutants 68/100
ruby/rdoc#1823 · 5 commentaires ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de ruby/rdoc
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
rubyevents/rubyevents#2277 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 1-3 heures Accessibilité débutants 92/100
Les mainteneurs répondent en général sous 2 jours