Docs: updated README.rst file
#563
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
product-auto-label
bot
added
the
api: spanner
google-cla
bot
added
the
cla: yes
c24t
reviewed
Dec 7, 2020
README.rst
Outdated
| } | ||
| } | ||
|
|
||
| - In order to retrieve the Cloud Spanner credentials from a JSON file, ``credentials_uri`` parameter can also be supplied in the ``OPTIONS`` field: |
There was a problem hiding this comment.
Suggested change
| - In order to retrieve the Cloud Spanner credentials from a JSON file, ``credentials_uri`` parameter can also be supplied in the ``OPTIONS`` field: | |
| - In order to retrieve the Cloud Spanner credentials from a JSON file, the ``credentials_uri`` parameter can also be supplied in the ``OPTIONS`` field: |
README.rst
Outdated
| @@ -27,7 +42,7 @@ To install from PyPI: | |||
| pip3 install django-google-spanner | |||
|
|
|||
|
|
|||
| To install from source: | |||
| To install from the source: | |||
There was a problem hiding this comment.
Suggested change
| To install from the source: | |
| To install from source: |
"Install from source" actually sounds more natural to me. I was curious, but don't know that this proves anything:
README.rst
Outdated
| constraints | ||
| <https://github.com/googleapis/python-spanner-django/issues/313>`__. | ||
| Spanner does not support ``ON DELETE CASCADE`` when creating foreign-key | ||
| constraints, so these are not supported in ``django-google-spanner``. |
There was a problem hiding this comment.
Suggested change
| constraints, so these are not supported in ``django-google-spanner``. | |
| constraints, so this is not supported in ``django-google-spanner``. |
README.rst
Outdated
|
|
||
| Check constraints aren't supported | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Spanner doesn't support ``CHECK`` constraints so one isn't created for | ||
| Spanner does not support ``CHECK`` constraints, so one isn't created for |
There was a problem hiding this comment.
"Doesn't" get expanded by "isn't" doesn't?
| @@ -189,13 +192,11 @@ Spanner doesn't support it. For example: | |||
| Schema migrations | |||
| ~~~~~~~~~~~~~~~~~ | |||
|
|
|||
| Spanner has some limitations on schema changes which you must respect: | |||
| There are some limitations on schema changes to consider: | |||
There was a problem hiding this comment.
Looks like this one has already been fixed.
docs/django-spanner-usage.rst
Outdated
| Usage | ||
| ===== | ||
|
|
||
| [this page is under construction] |
There was a problem hiding this comment.
I think it's better to avoid checking "under construction" pages in, and just add them once they're written.
README.rst
Outdated
| To use this library you'll need a Google Cloud Platform project with the Cloud | ||
| Spanner API enabled. See the `Cloud Spanner Python client docs | ||
| Using this library requires a Google Cloud Platform project with the Cloud | ||
| Spanner API enabled. See the Spanner' Python Client `documentation |
There was a problem hiding this comment.
Suggested change
| Spanner API enabled. See the Spanner' Python Client `documentation | |
| Spanner API enabled. See the Spanner Python client `documentation |
I'm no usage expert, but I think "Spanner" and "Python" are capitalized here as separate terms -- not as part of "Spanner Python Client" -- and "client" can be lowercase.
c24t
approved these changes
Dec 15, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changelog:
README.rstfile to reflect the latest state of development;connection-usage.rstfile.