[Aliki] Improve header links #1465
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
|
🚀 Preview deployment available at: https://a80aa8a2.rdoc-6cd.pages.dev (commit: f183f9b) |
st0012
force-pushed
the
remove-outdated-go-to-top-link
branch
from
fb9f104 to
62101ed
Compare
st0012
force-pushed
the
remove-outdated-go-to-top-link
branch
from
62101ed to
f183f9b
Compare
voxik
added a commit
to voxik/sinatra
that referenced
this pull request
Dec 3, 2025
With RDco 6.16, the following test started to fail: ~~~ 1) Failure: RdocTest#test_renders_rdoc_files_in_views_path_0 [test/rdoc_test.rb:25]: Expected /<h1[^>]*>Hello From RDoc(<span><a href=\"#label-Hello\+From\+RDoc\">¶<\/a> <a href=\"#(documentation|top)\">↑<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT "\n<h1 id=\"label-Hello+From+RDoc\"><a href=\"#label-Hello+From+RDoc\">Hello From RDoc</a></h1>\n". 2) Failure: RdocTest#test_renders_inline_rdoc_strings_0 [test/rdoc_test.rb:19]: Expected /<h1[^>]*>Hiya(<span><a href=\"#label-Hiya\">¶<\/a> <a href=\"#(documentation|top)\">↑<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT "\n<h1 id=\"label-Hiya\"><a href=\"#label-Hiya\">Hiya</a></h1>\n". ~~~ and it is caused by this change: ruby/rdoc#1465 The error happens due to over-prescriptive RDoc check, it seems. Looking into history, it seems the intention was just to check if RDoc works. However, the check later started to look too much into details of rendering. Therefore, relax the check to look only for know text and basic formatting and leave the rest as RDoc implementation detail. Fixes sinatra#2131
voxik
added a commit
to voxik/sinatra
that referenced
this pull request
Dec 3, 2025
With RDoc 6.16.0, the following test started to fail: ~~~ 1) Failure: RdocTest#test_renders_rdoc_files_in_views_path_0 [test/rdoc_test.rb:25]: Expected /<h1[^>]*>Hello From RDoc(<span><a href=\"#label-Hello\+From\+RDoc\">¶<\/a> <a href=\"#(documentation|top)\">↑<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT "\n<h1 id=\"label-Hello+From+RDoc\"><a href=\"#label-Hello+From+RDoc\">Hello From RDoc</a></h1>\n". 2) Failure: RdocTest#test_renders_inline_rdoc_strings_0 [test/rdoc_test.rb:19]: Expected /<h1[^>]*>Hiya(<span><a href=\"#label-Hiya\">¶<\/a> <a href=\"#(documentation|top)\">↑<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT "\n<h1 id=\"label-Hiya\"><a href=\"#label-Hiya\">Hiya</a></h1>\n". ~~~ and it is caused by this change: ruby/rdoc#1465 The error happens due to over-prescriptive RDoc check, it seems. Looking into history, it seems the intention was just to check if RDoc works. However, the check later started to look too much into details of rendering. Therefore, relax the check to look only for know text and basic formatting and leave the rest as RDoc implementation detail. Fixes sinatra#2131
voxik
added a commit
to voxik/sinatra
that referenced
this pull request
Dec 3, 2025
With RDoc 6.16.0, the following test started to fail: ~~~ 1) Failure: RdocTest#test_renders_rdoc_files_in_views_path_0 [test/rdoc_test.rb:25]: Expected /<h1[^>]*>Hello From RDoc(<span><a href=\"#label-Hello\+From\+RDoc\">¶<\/a> <a href=\"#(documentation|top)\">↑<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT "\n<h1 id=\"label-Hello+From+RDoc\"><a href=\"#label-Hello+From+RDoc\">Hello From RDoc</a></h1>\n". 2) Failure: RdocTest#test_renders_inline_rdoc_strings_0 [test/rdoc_test.rb:19]: Expected /<h1[^>]*>Hiya(<span><a href=\"#label-Hiya\">¶<\/a> <a href=\"#(documentation|top)\">↑<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT "\n<h1 id=\"label-Hiya\"><a href=\"#label-Hiya\">Hiya</a></h1>\n". ~~~ and it is caused by this change: ruby/rdoc#1465 The error happens due to over-prescriptive RDoc check, it seems. Looking into history, it seems the intention was just to check if RDoc works. However, the check later started to look too much into details of rendering. Therefore, relax the check to look only for know text and basic formatting and leave the rest as RDoc implementation detail. Fixes sinatra#2131
voxik
added a commit
to voxik/sinatra
that referenced
this pull request
Dec 3, 2025
With RDoc 6.16.0, the following test started to fail: ~~~ 1) Failure: RdocTest#test_renders_inline_rdoc_strings_0 [test/rdoc_test.rb:19]: Expected /<h1[^>]*>Hiya(<span><a href=\"#label-Hiya\">¶<\/a> <a href=\"#(documentation|top)\">↑<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT # valid: true "\n<h1 id=\"label-Hiya\"><a href=\"#label-Hiya\">Hiya</a></h1>\n". 2) Failure: RdocTest#test_renders_rdoc_files_in_views_path_0 [test/rdoc_test.rb:25]: Expected /<h1[^>]*>Hello From RDoc(<span><a href=\"#label-Hello\+From\+RDoc\">¶<\/a> <a href=\"#(documentation|top)\">↑<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT # valid: true "\n<h1 id=\"label-Hello+From+RDoc\"><a href=\"#label-Hello+From+RDoc\">Hello From RDoc</a></h1>\n". ~~~ and it is caused by this change: ruby/rdoc#1465 The error happens due to over-prescriptive RDoc check, it seems. Looking into history, it seems the intention was just to check if RDoc works. However, the check later started to look too much into details of rendering. Therefore, relax the check to look only for know text and basic formatting and leave the rest as RDoc implementation detail. Fixes sinatra#2131
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
toplinks next to the headers. This is a bad way to provide go-to-top feature. If users want it, we should do it differently in Aliki.