build: update README to indicate that source has moved#1038
Conversation
product-auto-label
Bot
added
the
api: datastore
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the README.md to inform users that the repository has been archived and its contents moved. While the intent is correct, the added note uses reStructuredText (RST) syntax within a Markdown file. This will cause rendering issues on platforms like GitHub and PyPI. I've provided a suggestion to use proper Markdown syntax to ensure the note is displayed correctly.
Note: Security Review has been skipped due to the limited scope of the PR.
| :**NOTE**: **This github repository is archived. The repository contents and history have moved to** `google-cloud-python`_. | ||
|
|
||
| .. _google-cloud-python: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-ndb |
There was a problem hiding this comment.
The README.md file is treated as Markdown, as indicated by its .md extension and its usage in setup.py with long_description_content_type="text/markdown". The current syntax for the note and link is reStructuredText (RST), which will not render correctly. To ensure the note is properly displayed on GitHub and PyPI, it should be converted to Markdown syntax. Using a blockquote will also help the note stand out.
2 participants
Towards googleapis/google-cloud-python#10916