Skip to content

docs(cloud_scheduler): trim sample comments - #14771

Open
iennae wants to merge 1 commit into
mainfrom
fix/cloud-scheduler-comments
Open

iennae wants to merge 1 commit into
mainfrom
fix/cloud-scheduler-comments

Conversation

@iennae

@iennae iennae commented Nov 7, 2026

Copy link
Copy Markdown
Contributor

Description

Follow-up to #14767. This trims the comments and two docstrings in the Cloud Scheduler samples so that each comment states one fact a reader needs. The code doesn't change.

  • Multi-line comments are now one line, for example the schedule and time zone, the attempt deadline, the retry limits and backoff, and the ABORTED behavior on pause, resume, and update.
  • Removed comments that restated the code, such as list pagination and the App Engine deadline.
  • Shortened the create_job and cloudscheduler_receiver docstrings.

11 files changed, net 37 fewer lines.

Checklist

Testing

  • I have tested this change on a live environment and verified it works as intended. This changes only comments. Unit tests pass (39 for the job samples and 4 for the receiver), and the integration tests are skipped without credentials.

Compliance & Style


Post-Approval Actions

  • Please merge this PR for me once it is approved

Shorten the comments and two docstrings in the Cloud Scheduler samples so
that each comment states one fact a reader needs, and remove comments
that restate the code. The code doesn't change.
@iennae
iennae requested review from a team as code owners November 7, 2026 03:37
@product-auto-label product-auto-label Bot added the samples Issues that are directly related to samples. label Nov 7, 2026

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

Copy link
Copy Markdown
Contributor

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 simplifies and shortens inline comments and docstrings across various Cloud Scheduler receiver and snippet files to improve conciseness and readability. No functional code changes were introduced. I have no feedback to provide.

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

Labels

samples Issues that are directly related to samples.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant