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

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

Merged
merged 1 commit into from
Jul 13, 2022
Merged

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

merged 1 commit into from
Jul 13, 2022

Conversation

rwhogg
Copy link
Contributor

@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 as a code owner July 13, 2022 17:50
dandhlee
dandhlee reviewed Jul 13, 2022
View reviewed changes
Copy link
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.

synthtool/gcp/templates/python_library/README.rst Show resolved Hide resolved
dandhlee
dandhlee requested changes Jul 13, 2022
View reviewed changes
Copy link
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?

@rwhogg
fix(python): Use rst-style links in README template for python branches
6c6c890 
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
dandhlee
dandhlee approved these changes Jul 13, 2022
View reviewed changes
Copy link
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
Reviewers

@dandhlee dandhlee dandhlee approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rwhogg @dandhlee @kokoro-team