Skip to content

docs(python): Use rst-style links in README template for python branches#1487

Merged
dandhlee merged 1 commit intogoogleapis:masterfrom
rwhogg:python-template-fix-branch-links
Jul 13, 2022
Merged

docs(python): Use rst-style links in README template for python branches#1487
dandhlee merged 1 commit intogoogleapis:masterfrom
rwhogg:python-template-fix-branch-links

Conversation

@rwhogg
Copy link
Copy Markdown

@rwhogg rwhogg commented Jul 13, 2022

The Markdown-style links do not render as intended when viewed by
GitHub.

@rwhogg rwhogg requested a review from a team July 13, 2022 17:50
Copy link
Copy Markdown
Contributor

@dandhlee dandhlee left a comment

Choose a reason for hiding this comment

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

Thank you for noticing this! One minor comment.

Comment thread synthtool/gcp/templates/python_library/README.rst
Copy link
Copy Markdown
Contributor

@dandhlee dandhlee left a comment

Choose a reason for hiding this comment

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

It seems that the rest of the page uses this kind of format:

`link`_

.. _reference: ...

Could you update so that we're consistent with this format?

The Markdown-style links do not render as intended when viewed by
GitHub.
@rwhogg rwhogg requested a review from dandhlee July 13, 2022 19:03
Copy link
Copy Markdown
Contributor

@dandhlee dandhlee left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you!

@dandhlee dandhlee added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 13, 2022
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 13, 2022
@dandhlee dandhlee changed the title fix(python): Use rst-style links in README template for python branches docs(python): Use rst-style links in README template for python branches Jul 13, 2022
@dandhlee dandhlee merged commit 8707c2a into googleapis:master Jul 13, 2022
@rwhogg rwhogg deleted the python-template-fix-branch-links branch July 13, 2022 23:27
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