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

docs: fix typo #4081

Merged
merged 1 commit into from
Nov 22, 2021
Merged

docs: fix typo #4081

merged 1 commit into from
Nov 22, 2021

Conversation

idleberg
Copy link
Contributor

@idleberg idleberg commented Nov 22, 2021

This PR has previously been made in the documentation repository. @MylesBorins left the following comment before closing that PR.

With that said I don't think this is a change we would land. in the rendered documentation it is not longer a markdown file.

I think the intention for the fix has been misunderstood. I'm assuming that the documentation runs through some kind of build process, where the Markdown files are converted to HTML. However, this PR does not try to change any of those links, but the text used on that link.

See this screenshot of the affected paragraph:

Screenshot 2021-11-22 at 18 34 59

Elsewhere on the same page, the same link is used but with a different text. Here's another screenshot of that paragraph:

Screenshot 2021-11-22 at 18 39 34

This text makes more sense and matches the title of the linked document, so the same should be applied to the other occurence of the link – this PR does just that.

@idleberg idleberg requested a review from a team as a code owner November 22, 2021 17:43
@wraithgar wraithgar changed the base branch from latest to release-next November 22, 2021 17:49
@wraithgar wraithgar changed the title Fix typo docs: fix typo Nov 22, 2021
PR-URL: #4081
Credit: @idleberg
Close: #4081
Reviewed-by: @wraithgar
@wraithgar wraithgar merged commit 2fbf157 into npm:release-next Nov 22, 2021
@wraithgar wraithgar mentioned this pull request Dec 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants