Improve misleading examples#44304
Open
jmorahan wants to merge 1 commit into
Open
Conversation
The examples for how relative URLs are constructed, while technically correct, give a misleading impression that `../` is needed to get from `/dogs` to `/cats`, which is not the case. This replaces those examples with clearer ones.
github-actions
Bot
added
Content:WebAPI
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
2 participants
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.
The examples for how relative URLs are constructed, while technically correct, give a misleading impression that
../is needed to get from/dogsto/cats, which is not the case. This replaces those examples with clearer ones.Description
Replaces
with
and adjusts anything else that needs to change as a result.
Motivation
The previous example might mislead readers into thinking that relative URLs are constructed by always treating the last path element as if it ends with a trailing slash.