CARVIEW |
Select Language
HTTP/2 200
date: Sat, 26 Jul 2025 02:07:32 GMT
content-type: text/html; charset=utf-8
cache-control: no-cache
content-security-policy: default-src 'none'; base-uri 'self'; child-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com *.rel.tunnels.api.visualstudio.com wss://*.rel.tunnels.api.visualstudio.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com proxy.individual.githubcopilot.com proxy.business.githubcopilot.com proxy.enterprise.githubcopilot.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com api.githubcopilot.com api.individual.githubcopilot.com api.business.githubcopilot.com api.enterprise.githubcopilot.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com private-avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com release-assets.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com copilotprodattachments.blob.core.windows.net/github-production-copilot-attachments/ github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/
referrer-policy: no-referrer-when-downgrade
server-timing: pull_request_layout-fragment;desc="pull_request_layout fragment";dur=287.691816,conversation_content-fragment;desc="conversation_content fragment";dur=495.113932,conversation_sidebar-fragment;desc="conversation_sidebar fragment";dur=237.901512,nginx;desc="NGINX";dur=1.130862,glb;desc="GLB";dur=101.292919
strict-transport-security: max-age=31536000; includeSubdomains; preload
vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, X-Requested-With,Accept-Encoding, Accept, X-Requested-With
x-content-type-options: nosniff
x-frame-options: deny
x-voltron-version: a2eb102
x-xss-protection: 0
server: github.com
content-encoding: gzip
accept-ranges: bytes
set-cookie: _gh_sess=jHz%2FYH1Lv71nssM1iRLg15NylZSax7g7mCCJzlIgvLwC3lw89RgBk%2BiK8P27T6uz63huO1bK6MZXyCkzzqe1dYMX95F9RwsIdhTbArECgoVyZVovNHKuqw88ZI8Yw7s2ZnWJYi8HqUaskNAubpyYeO%2F9WcdGhnUyUfbS50mDQNZBiH0RByj%2FFI7DqzuRcnGhPh7CGtk%2BEnZc6EorDzFxTCz8Q8Ho3CzSAKKwY4hTP1Uj4uYWksBguQxw3it%2FCbMaQJDCdVYgjiffM5JrYQoUmQ%3D%3D--k3XwnZHhTNbHESJG--hWwcos5uY9yTcvueXG6S1A%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.1749971394.1753495651; Path=/; Domain=github.com; Expires=Sun, 26 Jul 2026 02:07:31 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Sun, 26 Jul 2026 02:07:31 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: C69A:363053:B339E:11A2E2:68843863
Fix HTML links generated by special resource names by claudiob · Pull Request #93 · zipmark/rspec_api_documentation · GitHub
claudiob
deleted the
convert-resource-name-to-filename-compatible-string
branch
October 15, 2013 16:14
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 372
Fix HTML links generated by special resource names #93
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
Closed
claudiob
wants to merge
1
commit into
zipmark:master
from
claudiob:convert-resource-name-to-filename-compatible-string
Closed
Fix HTML links generated by special resource names #93
claudiob
wants to merge
1
commit into
zipmark:master
from
claudiob:convert-resource-name-to-filename-compatible-string
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
This commit ensures that the links from the `index` page to the `examples` pages of the generated HTML documentation are not broken when the resource name includes special characters like `:`.
I think you could check this in a spec for example.rb. It might be worth having in other writers. I expect that Raddocs has this problem as well. |
Came up with a simple test to get this in. The feature file has a simple spec that contains "::", a pretty indirect test but it fails without it. |
👍 |
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.
You can’t perform that action at this time.
This commit ensures that the links from the
index
page to theexamples
pages of the generated HTML documentation are not brokenwhen the resource name includes special characters like
:
.I'm aware this pull request needs tests to be accepted; however I was not sure how to write the required tests.
I will explain how to reproduce the bug solved by this PR here and hopefully get some feedback on how to write the test (and update this PR accordingly):
example
spec/acceptance/orders_spec.rb
, changingresource "Orders"
toresource "Super::Orders"
rake docs:generate
doc/api/index.html
in the browserCreating an order
super::orders/creating_an_order.html
, that is, it will interpretsuper
as the URL protocol, rather than linking to an HTML file in a subfolderMy commit replaces any non-ASCII character with an underscore, which generates filesystem-acceptable filenames