Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ParadoxV5 opened this issue Aug 24, 2023 · 1 comment
Open

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

ParadoxV5 opened this issue Aug 24, 2023 · 1 comment

Comments

@ParadoxV5
Copy link

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.

@ParadoxV5
Copy link
Author

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

ParadoxV5 added a commit to ParadoxV5/Godot.rb that referenced this issue Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant