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

Mark deprecated Flux command options in help output. #451

Conversation

blackwinter
Copy link
Member

Amends metafacture/metafacture-documentation#19 and #447.

New output:

encode-yaml
-----------
- description:  Serialises an object as YAML.
- options:      arraymarker (String), [deprecated] prettyprinting (boolean)
- signature:    StreamReceiver -> String
- java class:   org.metafacture.yaml.YamlEncoder

Copy link
Member

@dr0i dr0i left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice!

@blackwinter blackwinter merged commit 68c34e7 into master Jun 3, 2022
@blackwinter blackwinter deleted the metafacture-documentation-19-markDeprecatedFluxCommandOptions branch June 3, 2022 07:12
dr0i added a commit to metafacture/metafacture-documentation that referenced this pull request Jun 3, 2022
With metafacture/metafacture-core#451 it's possible
to mark "options" as deprecated. This is nicer than just have a not in
the "description".
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Metafacture alt
Awaiting triage
Development

Successfully merging this pull request may close these issues.

None yet

2 participants