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

Remove Shelley prefix on from errors #262

Merged
merged 1 commit into from
Sep 12, 2023

Conversation

newhoggy
Copy link
Contributor

@newhoggy newhoggy commented Sep 9, 2023

Changelog

- description: |
    Remove `Shelley` prefix on from errors
# 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
  - improvement    # QoL changes e.g. refactoring
  # - 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

Remove Shelley prefix from error types and constructors. Pretty much all code going forward is going to be Shelley based. The Shelley prefix is redundant because there isn't a need to distinguish it from anything else.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • The change log section in the PR description has been filled in
  • New tests are added if needed and existing tests are updated. These may include:
    • golden tests
    • property tests
    • round trip tests
    • integration tests
      See Running tests for more details
  • The version bounds in .cabal files are updated
  • CI passes. See note on CI. The following CI checks are required:
    • Code is linted with hlint. See .github/workflows/check-hlint.yml to get the hlint version
    • Code is formatted with stylish-haskell. See .github/workflows/stylish-haskell.yml to get the stylish-haskell version
    • Code builds on Linux, MacOS and Windows for ghc-8.10.7 and ghc-9.2.7
  • The changelog section in the PR is updated to describe the change
  • Self-reviewed the diff

@newhoggy newhoggy marked this pull request as ready for review September 9, 2023 02:11
@newhoggy newhoggy force-pushed the newhoggy/remove-shelley-prefix-on-from-errors branch from b9afe78 to 5742c6e Compare September 9, 2023 02:13
| GenesisCmdGenesisFileDecodeError !FilePath !Text
| GenesisCmdGenesisFileError !(FileError ())
| GenesisCmdFileError !(FileError ())
| GenesisCmdMismatchedGenesisKeyFiles [Int] [Int] [Int]
Copy link
Contributor

Choose a reason for hiding this comment

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

GenesisCmdMismatchedGenesisKeyFiles is in desperate need of commentary

@@ -0,0 +1,14 @@
module Cardano.CLI.Types.Errors.AddressInfoError
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this need a separate module?

Copy link
Contributor Author

@newhoggy newhoggy Sep 12, 2023

Choose a reason for hiding this comment

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

I put it separate from the command error because I think command errors should be separate from domain errors. I'm wondering if we should have a separate parent module for command errors.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Merging now. Can refactor later.

@newhoggy newhoggy added this pull request to the merge queue Sep 12, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 12, 2023
@newhoggy newhoggy added this pull request to the merge queue Sep 12, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 12, 2023
@newhoggy newhoggy added this pull request to the merge queue Sep 12, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 12, 2023
@newhoggy newhoggy added this pull request to the merge queue Sep 12, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 12, 2023
@newhoggy newhoggy force-pushed the newhoggy/remove-shelley-prefix-on-from-errors branch from 5742c6e to 9912955 Compare September 12, 2023 10:23
@newhoggy newhoggy force-pushed the newhoggy/remove-shelley-prefix-on-from-errors branch from 9912955 to 33fa8a1 Compare September 12, 2023 11:46
@newhoggy newhoggy enabled auto-merge September 12, 2023 11:47
@newhoggy newhoggy added this pull request to the merge queue Sep 12, 2023
Merged via the queue into main with commit 7069593 Sep 12, 2023
19 checks passed
@newhoggy newhoggy deleted the newhoggy/remove-shelley-prefix-on-from-errors branch September 12, 2023 12:36
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.

3 participants