docs(spanner): some documentation tweaks #11641
Conversation
Fixed some typos in the landing page: `THis` vs. `This` and `C++11` when we only support C++14. With DocFX we don't have deep linking to sections of pages working, the page is small, so just link the page for now.
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #11641 +/- ##
=======================================
Coverage 93.77% 93.77%
=======================================
Files 1824 1824
Lines 164431 164431
=======================================
+ Hits 154191 154202 +11
+ Misses 10240 10229 -11 ☔ View full report in Codecov by Sentry. |
| @@ -25,9 +25,9 @@ into your project. | |||
| - [Client::Read()](@ref google::cloud::spanner::Client::Read()) - to read the | |||
There was a problem hiding this comment.
s/ -// to match the form of the previous two entries.
| @@ -25,9 +25,9 @@ into your project. | |||
| - [Client::Read()](@ref google::cloud::spanner::Client::Read()) - to read the | |||
| rows in a table. | |||
| - @ref spanner-error-handling to learn how the library reports run-time errors. | |||
| - @ref spanner-env-logging enable logging. THis can be an effective approach to | |||
| diagnose many problems. | |||
| - @ref spanner-env for environment variables affecting the library. | |||
There was a problem hiding this comment.
This link leads to a page where a :cloud: becomes an image.
There was a problem hiding this comment.
Should be fixed in #11642
| - @ref spanner-env for environment variables affecting the library. | ||
| - @ref spanner-env includes environment variables to enable logging. This can be |
There was a problem hiding this comment.
s/spanner-env/spanner-env-logging/? Although that seemed to lead nowhere.
Perhaps it is just that the two spanner-env entries should be combined?
There was a problem hiding this comment.
spanner-env-logging is not working with the DocFX-based docs, but works with Doxygen. Merged the two entries.
| - @ref spanner-env for environment variables affecting the library. | ||
| - @ref spanner-env includes environment variables to enable logging. This can be | ||
| an effective approach to diagnose many problems. | ||
| - @ref spanner-endpoint-example | ||
| - @ref spanner-auth-example |
There was a problem hiding this comment.
This leads to a page where two links are not separated by any space.
There was a problem hiding this comment.
Fixed. I used the same structure as the generated documents, if you want we can make it nicer as this is a hand-crafted library.
Fixed some typos in the landing page:
THisvs.ThisandC++11when we only support C++14. With DocFX we don't have deep linking to sections of pages working, the page is small, so just link the page for now.This change is