Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

How to put invisible comment in included file?

Aperta
#1,691 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
ruby
Ambito
documentation

Direzione di ricerca

Inizia da ruby/ruby/doc/examples/files.rdoc e verifica come RDoc gestisce i tentativi di usare :stopdoc:/:startdoc:, =begin/=end e le forme di commento in stile HTML nei file .rdoc inclusi. Determina se una sintassi esistente può nascondere l’avviso preservando gli esempi inclusi, oppure quale dovrebbe essere il comportamento di una soluzione supportata; il lavoro è completo quando l’avviso è assente dalla documentazione generata senza influire sugli esempi.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Ruby
Stelle
930
Fork
465
Merge medio
3g 4h
PR unite (30g)
30

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ruby/rdoc

Tutte le issue di ruby/rdoc

Issue simili

Altre issue su Ruby

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.