docs(spanner): fix single character parameter #48
Conversation
|
@larkee I have tried something to fix that, if it looks good to you than i will take cleanup for whole library. |
There was a problem hiding this comment.
This looks good! Just a couple of nits.
Also, I would like if the link to the proto documentation could be added to the type rather than in the description. Just to be consistent with the other links to the Python documentation and other API documentation. However I'm not sure if this is possible to do while maintaining the class path.
Could you may look into this? If it's not feasible or is difficult to read, then what you currently have is good.
google/cloud/spanner_v1/snapshot.py
Outdated
| :class:`~google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryMode` | ||
| :param query_mode: Mode governing return of results / query plan. | ||
| See : | ||
| `QueryMode1 <https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest.QueryMode1>`_ |
There was a problem hiding this comment.
I think this is a typo.
https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest.QueryMode1 doesn't actually link properly to the right part of the page. It should be https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest.QueryMode
google/cloud/spanner_v1/snapshot.py
Outdated
| :class:`~google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryMode` | ||
| :param query_mode: Mode governing return of results / query plan. | ||
| See : | ||
| `QueryMode1 <https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest.QueryMode1>`_ |
There was a problem hiding this comment.
Replace space with full stop.
google/cloud/spanner_v1/snapshot.py
Outdated
| https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest.QueryMode1 | ||
| :class:`~google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryMode` | ||
| :param query_mode: Mode governing return of results / query plan. | ||
| See : |
There was a problem hiding this comment.
Remove the space before the colon.
|
Ah. I didn't think to check the other clients. In that case, this way is fine. However, I noticed the issue exists in the client API page as well.
It's not as significant but it should a similar change. Other than that, LGTM 👍 |
|
For me works fine with the 'firefox' updated version but found issue with the |
I prefer the line break. |
…into spanner_issue_47
…into spanner_issue_47
Fixes #47
Transaction class:
Snapshot class
