How to put invisible comment in included file?
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 45/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- Calme
- Stack technique
- ruby
- Domaine
- documentation
Piste de recherche
Commencez par ruby/ruby/doc/examples/files.rdoc et examinez comment RDoc gère les tentatives d’utiliser :stopdoc:/:startdoc:, =begin/=end et les formes de commentaires de style HTML dans les fichiers .rdoc inclus. Déterminez si une syntaxe existante peut masquer l’avertissement tout en préservant les exemples inclus, ou quel devrait être le comportement d’une solution prise en charge ; le travail est terminé lorsque l’avertissement est absent de la documentation générée sans affecter les exemples.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Over at ruby/ruby/doc/examples/files.rdoc, we have some code that supports examples in IO, File, and now Pathname.
File files.rdoc is included elsewhere.
I'd like to put into it an invisible warning (comment) about changing the file, since others depend upon it so closely.
I've tried :stopdoc:/:startdoc: and =begin/=end. Even an HTML-style comment like .
Is there some way to make an invisible comment in an included .rdoc file.
- Langage dominant
- Ruby
- Étoiles
- 930
- Forks
- 465
- Merge moyen
- 3 j 4 h
- PR mergées (30 j)
- 30
Préparer son environnement
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 documentationOuverte
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
-
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
-
Difficulté 3/5 1-2 jours Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 35/100
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de ruby/rdoc
Issues similaires
-
security
Difficulté 2/5 1-3 heures 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 75/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
solana-foundation/pay-kit#341 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
julienXX/terminal-notifier#333 ·
-
Plash is no longer open sourceOuverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 82/100
serhii-londar/open-source-mac-os-apps#1419 ·
Les mainteneurs répondent en général sous 5 jours