docs: call a scheduled entry what the domain calls it - #592
Merged
Merged
Conversation
#569 settled that cron is the driver and schedule is the domain, and renamed the URL, the provider directory, the processor and the SDK. The CLI help text and the documentation were not renamed with them, so `osapi client node schedule list --help` said it listed cron entries. The eight help strings that named the thing a user manages are now scheduled entries. The ones that name cron itself stay: the file paths under /etc/cron.d, the five-field expression format, and the provider. Whether cron implements it is not the caller's concern, which is the reason the URL says schedule. Three of these were wrong rather than merely stale. The SDK page was titled Cron, documented `client.Cron.List()` and used CronCreateOpts and CronUpdateOpts throughout its examples. The field is `Schedule *ScheduleService` and the types are ScheduleCreateOpts and ScheduleUpdateOpts, so every call on that page named something that does not exist and none of it would compile. The page also linked to examples/sdk/client/cron.go, which is schedule.go, so the link was dead. The SDK dropdown and the service index listed it as Cron as well. Swept docs/, examples/ and the README for other stale symbols. There were none. Closes: #590 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FuKUsHFG1EqZXamffh9M2c
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #592 +/- ##
=======================================
Coverage 99.95% 99.95%
=======================================
Files 501 501
Lines 24099 24099
=======================================
Hits 24089 24089
Misses 10 10 Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #590, and three real defects that issue did not know about.
#569 settled that
cronis the driver andscheduleis the domain, and renamed the URL, the provider directory, the processor and the SDK. The help text and the documentation were left behind, soosapi client node schedule list --helpsaid it listed cron entries.The stale documentation was also wrong
The issue was filed about wording. Three of the findings are broken rather than merely old:
The SDK page documented an API that does not exist. It was titled
# Cron, said to access it viaclient.Cron.List(), and usedclient.CronCreateOptsandclient.CronUpdateOptsin every code sample. The real surface:Nothing on that page would have compiled. Anyone copying a sample got an undefined field.
A dead link. The page pointed at
examples/sdk/client/cron.go. The file isschedule.go.The navigation and the service index both listed it as Cron, so the renamed service was reachable only under its old name.
What changed, and what deliberately did not
Eight help strings and the documentation prose now say "scheduled entry". These stay as
cron, because they name cron itself rather than the domain:cmd/client_node_schedule_update.go:96—"New cron schedule expression". It is a cron expression, in the five-field formatcron_scheduleparses./etc/cron.d/and/etc/cron.{interval}/paths, the file modes table, and "the cron provider is a meta provider".Whether cron implements the entry is not the caller's concern, which is the reason the URL says
schedule. Where the implementation is the subject, the implementation's name is correct.Swept for the rest
One thing checked and deliberately not reported:
examples/sdk/client/cronis an 8.8MB executable on my disk, but it is gitignored and untracked, so it is a leftover from my own build rather than anything in the repository.just testpasses, includingdocusaurus-build, which fails on a broken internal link, anddocusaurus-fmt-check. Coverage 100%.🤖 Generated with Claude Code
https://claude.ai/code/session_01FuKUsHFG1EqZXamffh9M2c