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

Fix for Link in docs/Middleware #2192

Merged
merged 2 commits into from
Apr 11, 2020
Merged

Conversation

astorm
Copy link
Contributor

@astorm astorm commented Apr 10, 2020

I noticed these stray quotes broke this link when viewed via the github user interface. This PR makes this one link behave as the others do in the doc.

This is my first PR to this repo and I think I'm doing it right, but if there's extra process or a different branch/repo I should be submitting this to please let me know.

Checklist

  • run npm run test and npm run benchmark
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message and code follows Code of conduct

Copy link
Member

@Eomm Eomm left a comment

Choose a reason for hiding this comment

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

Thanks for reporting!

That syntax should be old (when we didn't add anchors)

docs/Middleware.md Outdated Show resolved Hide resolved
@Eomm Eomm added the documentation Improvements or additions to documentation label Apr 10, 2020
Co-Authored-By: Manuel Spigolon <behemoth89@gmail.com>
@jsumners
Copy link
Member

jsumners commented Apr 10, 2020

Those "stray quotes" are valid Markdown syntax for defining the link text -- https://www.markdownguide.org/basic-syntax#adding-titles

foo bar ([foo bar](http://example.com "An Example"))

^ hover your mouse on that link until the alt text pops up.

@astorm
Copy link
Contributor Author

astorm commented Apr 11, 2020

That's good information to know, thank you @jsumners, I had wondered what those were for.

However (and only to clarify my intent) the "stray quotes" I was referring to were the single quotes around the URL/URI portion of the link

[Reply]('./Reply.md' "Reply")

which resulted in a malformed hyperlink.

https://github.com/fastify/fastify/blob/master/docs/'./Reply.md'

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 10, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants