Skip to content

Update link syntax to RST from Markdown #9 - #10

Merged
steven-esser merged 1 commit into
masterfrom
9-update-link-syntax
May 14, 2019
Merged

Update link syntax to RST from Markdown #9#10
steven-esser merged 1 commit into
masterfrom
9-update-link-syntax

Conversation

@steven-esser

Copy link
Copy Markdown
Contributor

Signed-off-by: Steven Esser sesser@nexb.com

Signed-off-by: Steven Esser <sesser@nexb.com>
@steven-esser
steven-esser requested a review from DennisClark May 6, 2019 23:36
Comment thread docs/source/help.rst
******************

- **[ScanCode Toolkit](https://github.com/nexB/scancode-toolkit)**: This is a set of code scanning tools to detect the origin and license of code and dependencies. ScanCode Toolkit uses a plug-in architecture to run a series of scan-related tools in one process flow. This is the most popular project and is used by hundreds of software teams. https://github.com/nexB/scancode-toolkit . The lead maintainer is @pombredanne
- `ScanCode Toolkit <https://github.com/nexB/scancode-toolkit>`_: This is a set of code scanning tools to detect the origin and license of code and dependencies. ScanCode Toolkit uses a plug-in architecture to run a series of scan-related tools in one process flow. This is the most popular project and is used by hundreds of software teams. https://github.com/nexB/scancode-toolkit . The lead maintainer is @pombredanne

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you elaborate on the reason for these markup changes? what is the result from this visually?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Specifically I meant the use of backticks

@steven-esser steven-esser May 8, 2019

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@pombredanne Notice on this page (the current version of this file): https://aboutcode.readthedocs.io/en/latest/help.html

The links are still in Markdown Syntax, and not actually RST links. the backticks create valid RST links

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Perfect. Thank you for the details.
And will these still be bolded?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

No, there is currently no way to bold links like this in RST... See: http://docutils.sourceforge.net/FAQ.html#is-nested-inline-markup-possible

@steven-esser

Copy link
Copy Markdown
Contributor Author

Assuming this can be merged... Will wait a bit for any other comments.

@DennisClark

Copy link
Copy Markdown
Member

ok with me

@steven-esser
steven-esser merged commit f106356 into master May 14, 2019
@steven-esser
steven-esser deleted the 9-update-link-syntax branch June 17, 2019 20:07
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.

3 participants