Add descriptive documentation to compose schema properties#581
Add descriptive documentation to compose schema properties#581testA113 wants to merge 2 commits intocompose-spec:mainfrom
Conversation
Improved schema documentation by adding descriptive text to various properties in the JSON schema. This enhances usability for developers by providing clear explanations of what each property does. Signed-off-by: testA113 <[email protected]>
ndeloof
left a comment
There was a problem hiding this comment.
LGTM, could be later improved
ndeloof
left a comment
There was a problem hiding this comment.
version attribute must be documented as legacy, deprecated
Signed-off-by: testA113 <[email protected]>
05231d7 to
57efccc
Compare
|
Thankyou for the review @ndeloof! Let me know if you need any other changes |
|
This PR should be done in the https://github.com/compose-spec/compose-go repository, no? |
Lines 22 to 24 in d9b3470 If that is the case then we should add a |
Thanks for taking a look @glours! I've applied the same changes in the PR for the compose-go repo you mentioned here. I'll close this PR and let's continue the review there |
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 #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