Add descriptive documentation to compose schema properties#776
Merged
ndeloof merged 1 commit intocompose-spec:mainfrom Apr 27, 2025
Merged
Conversation
Signed-off-by: testA113 <[email protected]>
testA113
force-pushed
the
feature/add-schema-descriptions
branch
from
66aac37 to
c010f5f
Compare
ndeloof
approved these changes
Apr 27, 2025
This was referenced Apr 29, 2025
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
2 participants
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.
A PR applying the same changes as compose-spec/compose-spec#581, but to the source repo.
Description:
Improved schema documentation by adding descriptive text to various properties in the JSON schema.
This enhances DX by providing clear explanations of what each property does without requiring users to constantly refer to external documentation.
These changes address issue compose-spec/compose-spec#138.
The descriptions come from sane descriptions found in https://github.com/microsoft/compose-language-service/blob/7a74283ddb866988fed86241f461a657f0aee6d0/src/service/providers/KeyHoverProvider.ts#L63-L184