doc: remove inline namespace from doxygen #7461
Conversation
googlebot
added
the
cla: yes
|
Google Cloud Build Logs
ℹ️ NOTE: Kokoro logs are linked from "Details" below. |
Fixes: googleapis#7453 With this change, our Doxygen documentation will no longer make any mention of our inline namespace for versioning, thus the docs will be accurately reflecting what we actually want customers to type. This PR removes all references to `omit_this_inline_ns`.
|
Google Cloud Build Logs
ℹ️ NOTE: Kokoro logs are linked from "Details" below. |
Codecov Report
@@ Coverage Diff @@
## main #7461 +/- ##
=======================================
Coverage 93.64% 93.64%
=======================================
Files 1364 1364
Lines 118362 118362
=======================================
+ Hits 110842 110844 +2
+ Misses 7520 7518 -2
Continue to review full report at Codecov.
|
CHANGELOG.md
Outdated
| @@ -69,6 +69,22 @@ | |||
|
|
|||
| ## v1.33.0 - TBD | |||
|
|
|||
| **ATTENTION**: Users should generally **NOT** spell the name of our versioned | |||
There was a problem hiding this comment.
This paragraph assumes that one knows what "our versioned inline namespace" is. And it is a bit informal.
CHANGELOG.md
Outdated
| specific version of our library and will make upgrades more difficult for you. | ||
| Previously, this version was `v1` (but it will change in the future), and so | ||
| you may have some code that references, say, ~`google::cloud::v1::Status`~ | ||
| (WRONG) and you should instead prefer `google::cloud::Status` (omit the |
There was a problem hiding this comment.
Don't yell at the customers. Specially if it was our fault. Maybe just say:
For example, prefer using `google::cloud::Status` in your code, over `google::cloud::v1::Status`, as the latter makes it harder to update your code when upgrading the libraries.
CHANGELOG.md
Outdated
| (WRONG) and you should instead prefer `google::cloud::Status` (omit the | ||
| versioned inline namespace name). | ||
|
|
||
| Our Doxygen documentation (e.g. [Storage docs][storage-dox-link]) was |
There was a problem hiding this comment.
I would lead with this paragraph.
|
Google Cloud Build Logs
ℹ️ NOTE: Kokoro logs are linked from "Details" below. |
Fixes: #7453
With this change, our Doxygen documentation will no longer make any
mention of our inline namespace for versioning, thus the docs will be
accurately reflecting what we actually want customers to type.
This PR removes all references to
omit_this_inline_ns.This change is