docs(list-widget): correct min/max independence in docs (DCMS-283) - #1
Open
sempostma wants to merge 1 commit into
Open
docs(list-widget): correct min/max independence in docs (DCMS-283)#1sempostma wants to merge 1 commit into
sempostma wants to merge 1 commit into
Conversation
validateMinMax in decap-cms-lib-widgets checks min and max in independent branches (rangeMin/rangeMax), so either can be set alone. The docs incorrectly claimed each required the other.
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
1 participant
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.
Summary
DCMS-283: the List widget docs (
content/docs/widgets/list.md) claimedminrequiresmaxto be set, and vice versa. That's not what the code does.validateMinMaxinpackages/decap-cms-lib-widgets/src/validations.ts(decap-cms repo) has three independent branches:minandmaxset → range checkminset →rangeMinerrormaxset →rangeMaxerrorSo
minandmaxare each independently optional — setting either alone works and is validated correctly. This PR corrects the docs to match actual behavior; no code change needed.Internal tracker: DCMS-283 (
/Users/sempostma/Documents/personal/Projects/decap-cms/Issues/DCMS-283 - list-widget-min-max-docs-claim-false-interdependency.md)Test plan
validateMinMaxsource that min/max are independently checked