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

readme.rst: Broken link #3341

Closed
matmis opened this issue Jun 10, 2017 · 2 comments
Closed

readme.rst: Broken link #3341

matmis opened this issue Jun 10, 2017 · 2 comments
Labels
component: documentation good first issue If you want to help, this is is a good place to start level: easy
Milestone
2.5.0

Comments

@matmis
Copy link

matmis commented Jun 10, 2017

The "Class Discription" link under "What's Inside?" in readme.rst is broken.
@devyte
Copy link
Collaborator

devyte commented Sep 6, 2017

You are right. I don't know rst markup. Can you figure out the needed change and report it here? I can then fix it.

@igrr igrr added component: documentation good first issue If you want to help, this is is a good place to start level: easy labels Jan 2, 2018
@dragondaud
Copy link
Contributor

Existing: Class Description <class-description>__
Should be: Class Description_

Where a single underscore is an internal link, and the <> are not needed as the section name matches the link text. I will create a PR for this minor fix.

@dragondaud dragondaud mentioned this issue Sep 30, 2018
Merged
@devyte devyte added this to the 2.5.0 milestone Oct 1, 2018
@devyte devyte closed this as completed Oct 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
component: documentation good first issue If you want to help, this is is a good place to start level: easy
Projects
None yet
Milestone
2.5.0
Development

No branches or pull requests
4 participants
@igrr @matmis @devyte @dragondaud