Repository navigation
docs: Fix broken CloudEvents spec links in source comments - #57
Merged
Merged
Conversation
Signed-off-by: Adam Boulware <adam@adamboulware.com>
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
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.
Description
The
cloudevents/specrepository renamed its default branch frommastertomainand movedspec.mdtocloudevents/spec.md, sohttps://github.com/cloudevents/spec/blob/master/spec.mdnow returns 404.This updates three code comments in
src/CloudEventsPowerShell/CloudEvents.Sdk.psm1that point at the
datacontenttypeattribute to the file's current location:https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#datacontenttypeOnly the URL text changes (3 lines). These are plain
#comments insidefunction bodies, not comment-based help, so they are not shown by
Get-Help;only people reading the source see them.
Related to #56, which fixes the README community links for the same root cause
(the
cloudevents/specrestructure). This PR does not touch the README.Left unchanged on purpose:
v1.0.1(spec.md,http-protocol-binding.md). They stillreturn 200 and their anchors still exist.
CHANGELOG.mdcontains nocloudevents/speclinks, so there is no historyto leave as-is.
Type of change
Please mark options that are relevant:
not work as expected)
How Has This Been Tested?
Comment-only change; no code behaviour is affected.
github.com/cloudevents/specURL in the repo withcurl -L: the oldmaster/spec.mdURL returns 404, the newmain/cloudevents/spec.mdURL returns 200, and thev1.0.1links return 200.cloudevents/spec.mdonmain: there is exactly one#### datacontenttypeheading (the attributedefinition), so
#datacontenttyperesolves to the intended section.git diff --checkis clean; line endings (LF) and encoding are unchanged.Test Configuration:
Checklist:
guidelines
of this project