Open ParadoxV5 opened 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.
file_list.html
$ 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>
file.Extra File.html in file system, file.Extra_20File.html in href
file.Extra File.html
file.Extra_20File.html
href
Either:
file.Extra%20File.html
Ubuntu 23.04
ruby 3.2.2 (2023-03-30 revision e51014f9c0) [x86_64-linux]
yard 0.9.34
I have glanced over the Contributing Guide and CoC.
P.S.
Don’t use spaces in file names. Command lines will also thank me. But I like descriptive file names…
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
Actual Output
file.Extra File.html
in file system,file.Extra_20File.html
inhref
Expected Output
Either:
file.Extra File.html
in file system,file.Extra%20File.html
inhref
file.Extra_20File.html
in file system,file.Extra_20File.html
inhref
Environment details
Ubuntu 23.04
(does this matter for software errors?…)ruby 3.2.2 (2023-03-30 revision e51014f9c0) [x86_64-linux]
yard 0.9.34
(v1.0 when)I have glanced over the Contributing Guide and CoC.