search

metafacture / metafacture-core

Core package of the Metafacture tool suite for metadata processing.
https://metafacture.org
Apache License 2.0
71 stars 34 forks source link

Deprecate parameter "prettyPrinting" #447

Closed dr0i closed 2 years ago

dr0i commented 2 years ago

Jackson's YAMLGenerator ignores any PrettyPrinter. It's always pretty printed.

See metafacture/metafacture-documentation#19.

dr0i commented 2 years ago

The generated flux-commands.md would look like this:

encode-yaml
-----------
- description:¦-Serialises an object as YAML. The paramter 'prettyprinting (boolean)' is deprecated since it's not possible to not pretty print.
- options:¦-arraymarker (String), prettyprinting (boolean)

Nicer would be to have the deprecated note in options, but that would be need a bit more of programming. So - is this good enough?

dr0i commented 2 years ago

Merged and updated https://github.com/metafacture/metafacture-documentation/blob/master/flux-commands.md#encode-yaml. Closed.