cleanup: remove line wrapping for region tags so they can be embedded in docs#16087
cleanup: remove line wrapping for region tags so they can be embedded in docs#16087sereanaseim wants to merge 1 commit intogoogleapis:mainfrom
Conversation
There was a problem hiding this comment.
Code Review
This pull request consolidates multi-line Doxygen region tags into single lines within the storage bucket encryption enforcement samples. Feedback was provided regarding the placement of the END tags in the GetBucketEncryptionEnforcementConfig, SetBucketEncryptionEnforcementConfig, and UpdateBucketEncryptionEnforcementConfig functions. Currently, these tags are positioned between the lambda definitions and their invocations, which results in incomplete and non-runnable code snippets in the generated documentation. It is recommended to move these tags after the function calls to ensure the examples are functional.
| } | ||
| //! [get bucket encryption enforcement config] [END | ||
| //! storage_get_bucket_encryption_enforcement_config] | ||
| //! [get bucket encryption enforcement config] [END storage_get_bucket_encryption_enforcement_config] |
There was a problem hiding this comment.
The placement of this END region tag between the lambda's closing brace and its invocation results in a documentation snippet that is incomplete. The extracted code will contain the lambda definition but not the call, making it non-runnable as a standalone example. Consider moving this tag after the invocation (the next line) to ensure the documentation provides a complete, functional example.
| } | ||
| //! [set bucket encryption enforcement config] [END | ||
| //! storage_set_bucket_encryption_enforcement_config] | ||
| //! [set bucket encryption enforcement config] [END storage_set_bucket_encryption_enforcement_config] |
There was a problem hiding this comment.
The placement of this END region tag between the lambda's closing brace and its invocation results in a documentation snippet that is incomplete. The extracted code will contain the lambda definition but not the call, making it non-runnable as a standalone example. Consider moving this tag after the invocation (the next line) to ensure the documentation provides a complete, functional example.
| } | ||
| //! [update bucket encryption enforcement config] [END | ||
| //! storage_update_bucket_encryption_enforcement_config] | ||
| //! [update bucket encryption enforcement config] [END storage_update_bucket_encryption_enforcement_config] |
There was a problem hiding this comment.
The placement of this END region tag between the lambda's closing brace and its invocation results in a documentation snippet that is incomplete. The extracted code will contain the lambda definition but not the call, making it non-runnable as a standalone example. Consider moving this tag after the invocation (the next line) to ensure the documentation provides a complete, functional example.
|
/gcbrun |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #16087 +/- ##
==========================================
+ Coverage 92.68% 92.70% +0.01%
==========================================
Files 2351 2351
Lines 218117 218117
==========================================
+ Hits 202168 202205 +37
+ Misses 15949 15912 -37 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
No description provided.