lsegal / yard

YARD is a Ruby Documentation tool. The Y stands for "Yay!"
http://yardoc.org
MIT License
1.94k stars 397 forks source link

Mismatching name/link for spaces in extra files’ names #1504

Open ParadoxV5 opened 1 year ago

ParadoxV5 commented 1 year ago

Extra files with space(s) (and possibly other non-alphanumerics too) in their names have over-sanitized name in file_list.html and consequently sidebars on all pages.

Steps to reproduce

$ touch 'Extra File.txt'
$ yardoc - 'Extra File.txt'
Files:           0
Modules:         0 (    0 undocumented)
Classes:         0 (    0 undocumented)
Constants:       0 (    0 undocumented)
Attributes:      0 (    0 undocumented)
Methods:         0 (    0 undocumented)
 100.00% documented
$ ls doc/file.*
'doc/file.Extra File.html'
$ grep 'file\.' doc/file_list.html
    <div class="item"><span class="object_link"><a href="file.Extra_20File.html" title="Extra File">Extra File</a></span></div>

Actual Output

file.Extra File.html in file system, file.Extra_20File.html in href

Expected Output

Either:

Environment details


I have glanced over the Contributing Guide and CoC.

ParadoxV5 commented 1 year ago

P.S.

Workarounds

Don’t use spaces in file names. Command lines will also thank me. But I like descriptive file names…

Relates to

1289