Skip to content

cleanup: remove line wrapping for region tags so they can be embedded in docs#16087

Open
sereanaseim wants to merge 1 commit intogoogleapis:mainfrom
sereanaseim:docs
Open

cleanup: remove line wrapping for region tags so they can be embedded in docs#16087
sereanaseim wants to merge 1 commit intogoogleapis:mainfrom
sereanaseim:docs

Conversation

@sereanaseim
Copy link
Copy Markdown

No description provided.

@sereanaseim sereanaseim requested review from a team as code owners April 29, 2026 17:56
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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]
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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]
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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]
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

@scotthart
Copy link
Copy Markdown
Member

/gcbrun

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 29, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.70%. Comparing base (8a2d6da) to head (4b92ba7).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants