Skip to content

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

@ParadoxV5

Description

@ParadoxV5

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:

  • file.Extra File.html in file system, file.Extra%20File.html in href
  • file.Extra_20File.html in file system, file.Extra_20File.html in href

Environment details

  • OS: Ubuntu 23.04 (does this matter for software errors?…)
  • Ruby: ruby 3.2.2 (2023-03-30 revision e51014f9c0) [x86_64-linux]
  • YARD: yard 0.9.34 (v1.0 when)

I have glanced over the Contributing Guide and CoC.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions