docs: fix createdAt.maxNegativeDelta key name in CONFIGURATION.md#678
Open
Priyanshubhartistm wants to merge 1 commit into
Open
Conversation
🦋 Changeset detectedLatest commit: d471633 The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
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.
Description
CONFIGURATION.md documented the setting as
limits.event.createdAt.minNegativeDelta, but the actual key read by the code (and shipped inresources/default-settings.yaml) ismaxNegativeDelta. Corrected the key name and reordered the row to keep the settings table alphabetically sorted, per the convention stated at the top of the table ("Please keep this table sorted when adding new entries").Related Issue
Fixes #677
Motivation and Context
An operator who copies the documented key name (
minNegativeDelta) into theirsettings.yamlgets silent no-op behavior, because the relay never reads that key — onlymaxNegativeDeltahas any effect. This fixes the doc so it matchesresources/default-settings.yaml,src/handlers/event-message-handler.ts, andsrc/app/static-mirroring-worker.ts, all of which usemaxNegativeDelta.How Has This Been Tested?
This is a documentation-only change with no production source touched. Verified:
grep -rn "minNegativeDelta"across the codebase shows no other references (docs, tests, or source) needing the same fix.pnpm exec changeset status --since upstream/mainpasses (empty changeset, no version bump)..github/workflows/checks.yml'spaths-filter,CONFIGURATION.mddoesn't match thesrcfilter, solint/build-check/unit/integration test jobs won't run for this PR.Screenshots (if appropriate):
N/A — documentation-only change.
Types of changes
Checklist: