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.

Sign up for GitHub

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

Jump to bottom

free-floating URLs not parsed well by documenter #907

Open
kris-brown opened this issue May 9, 2024 · 1 comment
Open

free-floating URLs not parsed well by documenter #907

kris-brown opened this issue May 9, 2024 · 1 comment
Labels
docs

Comments

@kris-brown
Copy link
Contributor

@slwu89 points out that the docstring for image is broken. It is rendered as plain text "https://en.wikipedia.org/wiki/Image(categorytheory)#Second_definition" instead of a hyperlink to here
@kris-brown kris-brown added the docs label May 9, 2024
@epatters
Copy link
Member

epatters commented May 10, 2024 •
edited
Loading

Thanks for the report.

  • We should probably consider it bad style to put free-floating URLs in docstrings
  • If we are going to do that, then the correct Markdown syntax is to put the URL in angle brackets: <https://...>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@epatters @kris-brown