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

match casing of reference links to the casing of the actual referenced declaration/module #2500

Merged
merged 2 commits into from
Aug 10, 2023

Conversation

tayloraswift
Copy link
Contributor

@tayloraswift tayloraswift commented Aug 10, 2023

updating the link target casing to match the casing of the referenced declaration/module allows them to be resolved as symbol links by non-DocC tooling that supports multi-target documentation. it doesn’t seem to interfere with DocC’s ability to serve the slightly-modified URLs:

https://swiftpackageindex.com/apple/swift-nio/2.58.0/documentation/nioposix/multithreadedeventloopgroup

vs:

https://swiftpackageindex.com/apple/swift-nio/2.58.0/documentation/NIOPosix/MultiThreadedEventLoopGroup

these links are still broken when viewed anywhere besides the swift package index website, including GitHub itself. but this change at least allows them to be navigable in a few other places besides that website.

Copy link
Contributor

@Lukasa Lukasa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@Lukasa
Copy link
Contributor

Lukasa commented Aug 10, 2023

@swift-server-bot test this please

@Lukasa Lukasa enabled auto-merge (squash) August 10, 2023 07:23
@Lukasa Lukasa added the semver/none No version bump required. label Aug 10, 2023
@Lukasa Lukasa merged commit 8c2654c into apple:main Aug 10, 2023
5 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver/none No version bump required.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants