Repository navigation
docs: auto-sync other with merged PRs (through 2026-10-25) #15445
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,7 +8,7 @@ branch, so the rule is gone from its input, and the deletion itself is a correct | |
| extraction step is instructed not to undo. | ||
|
|
||
| <!-- docs-sync:learnings:start --> | ||
| - Explain why a flag or option is needed, not just that it exists. <!-- id=explain-flag-purpose scope=edit source=comment:4046075608 date=2026-09-18 --> | ||
| - Link the relevant reference documentation when describing platform-specific actions or shortcuts so the mapping is obvious. <!-- id=link-related-reference-docs scope=edit source=comment:4044915525 date=2026-09-18 --> | ||
| - State which plans and billing periods a fee applies to, including whether it covers annual plans, renewals, or only new monthly purchases. <!-- id=scope-fee-by-plan scope=edit source=comment:4045668762 date=2026-09-18 --> | ||
| - Explain why a required flag or option is needed rather than only stating that it is required. <!-- id=explain-required-flags scope=edit source=comment:4046075608 date=2026-09-18 --> | ||
| - Note when items created before a behavior change, such as older links or shares, may need to be retried. <!-- id=document-legacy-link-retries scope=edit source=comment:4053112613 date=2026-09-19 --> | ||
| - Link each listed item to the source change it documents when the introduction promises such references. <!-- id=fulfill-promised-references scope=edit source=comment:4053902533 date=2026-09-19 --> | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. WARNING: This re-adds rules that were deleted from These three added rules (same ids, same Net effect here is an oscillation with no new information: the same three September comments ( Worth checking whether the previous removal was intended before merging, and whether the deletion of |
||
| <!-- docs-sync:learnings:end --> | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
SUGGESTION: This narrows the rule from "a flag or option" to "a required flag or option".
The rule it replaces covered every flag/option; the new wording only covers required ones, so guidance for optional flags is silently lost even though the source (
comment:4046075608) is unchanged. Unless the maintainer correction was specifically about required flags, consider keeping the broader wording, e.g. "Explain why a flag or option is needed rather than only stating that it exists."