IntersectMBO / cardano-cli

This repository contains sources for the command-line interface (CLI) tool for interacting with the Cardano blockchain.
Apache License 2.0
37 stars 13 forks source link

Clarify help texts related to JSON and CBOR #751

Closed carbolymer closed 4 months ago

carbolymer commented 4 months ago

Changelog

- description: |
    Clarify help texts related to JSON and CBOR
# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  # - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
   - refactoring    # QoL changes
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

Some help texts were misleading, they were mentioning CBOR in JSON arguments and were referencing "special JSON schema" where "detailed JSON schema" should be used. This is a partial fix for: https://github.com/IntersectMBO/cardano-cli/issues/593

Checklist