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

Make links of hyperlinks (documentation) #3962

Closed
wants to merge 2 commits into from
Closed

Make links of hyperlinks (documentation) #3962

wants to merge 2 commits into from

Conversation

mjago
Copy link
Contributor

@mjago mjago commented Jan 31, 2017

Make documentation links `clickable'

@mjago
Copy link
Contributor Author

mjago commented Jan 31, 2017

@makenowjust Huh? So presumably these links shouldn't be hyperlinks ? I would assume some amount of consistency is preferable.

@makenowjust
Copy link
Contributor

@mjago Ah, yes. I wanted you to write description for explanation. And we may want to improve Markdown processor for such a style link.

In fact, I prefer <http://...> style link to [...](http://...) in this case because [...] content says little. I think the URL and the context describe themselves fully.

@mjago
Copy link
Contributor Author

mjago commented Jan 31, 2017

@makenowjust Ok sorry - added a description. My only issue was when I tried to follow the link I had to copy-and-paste. I assumed it was an oversight so I made the `tiny change' to the markup to be consistent with other linked references. I have no opinion on the link descriptions.

@makenowjust
Copy link
Contributor

@mjago But this pull request improve document quality. Good job!

@makenowjust
Copy link
Contributor

@mjago I think you missed fixing links in src/debug/mach_o.cr.

@mjago
Copy link
Contributor Author

mjago commented Jan 31, 2017

@makenowjust Thanks - now formatted also.

@ysbaddaden
Copy link
Contributor

ysbaddaden commented Feb 1, 2017

The markdown processor should be enhanced to support autolinks instead. See http://spec.commonmark.org/0.27/#autolink

@mjago mjago closed this Feb 5, 2017
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.

None yet

3 participants