Skip to content
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

Refactor yaml comment #1307

Merged
merged 1 commit into from
Apr 27, 2023
Merged

Refactor yaml comment #1307

merged 1 commit into from
Apr 27, 2023

Conversation

olblak
Copy link
Member

@olblak olblak commented Apr 27, 2023

I recently discovered that I could use multi line comment for jsonschema description field.
This pullrequest redesign the yaml parameter comment.

This is an attempt to see how it render both from the IDE and www.updatecli.io

Test

This pullrequest is just some comment update

Additional Information

Tradeoff

Potential improvement

Signed-off-by: Olblak <me@olblak.com>
@olblak olblak added the skip-changelog Used by release-drafter to ignore pullrequest in changelog label Apr 27, 2023
@olblak olblak merged commit 27aeab4 into updatecli:main Apr 27, 2023
4 checks passed
@olblak olblak added documentation Improvements or additions to documentation and removed skip-changelog Used by release-drafter to ignore pullrequest in changelog labels May 5, 2023
@olblak olblak changed the title Reformat yaml comment Refactor yaml comment May 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant