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

Clarify help texts related to JSON and CBOR #751

Merged
merged 1 commit into from
May 8, 2024

Conversation

carbolymer
Copy link
Contributor

@carbolymer carbolymer commented May 6, 2024

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: #593

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. See Running tests for more details
  • Self-reviewed the diff

Copy link
Contributor

@newhoggy newhoggy 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!

@carbolymer carbolymer added this pull request to the merge queue May 8, 2024
Merged via the queue into main with commit c5f92ea May 8, 2024
21 of 23 checks passed
@carbolymer carbolymer deleted the mgalazyn/chore/clarify-json-cbor-help-text branch May 8, 2024 11:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FR] - Provide JSON schema for input files
3 participants