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

Rename eon functions #281

Merged
merged 8 commits into from
Sep 29, 2023
Merged

Rename eon functions #281

merged 8 commits into from
Sep 29, 2023

Conversation

newhoggy
Copy link
Collaborator

@newhoggy newhoggy commented Sep 28, 2023

Changelog

- description: |
    - Rename `inShelleyBasedEraEonMaybe` to `forShelleyBasedEraInEonMaybe`
    - Rename `inShelleyBasedEraEon` to `forShelleyBasedEraInEon`
    - Rename `maybeEonInShelleyBasedEra` to `forShelleyBasedEraMaybeEon`
    - Rename `eonInShelleyBasedEra` to `inEonForShelleyBasedEra`
    - Rename `maybeEonInEra` to `forEraMaybeEon`
    - Rename `inEraEonMaybe` to `forEraInEonMaybe`
    - New `inEonForEraMaybe` function
    - New `inEonForShelleyBasedEraMaybe` function
# 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

The function names are composed on smaller positional components:

  • forEra - corresponds to CardanoEra era
  • forShelleyBasedEra - corresponds to ShelleyBasedEra era
  • inEon - corresponds to a and eon era -> a if not coupled with maybe otherwise corresponds to just eon era -> a
  • maybe - corresponds to Maybe a`
  • maybeEon - corresponds to Maybe (eon era)

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

Copy link
Contributor

@carbolymer carbolymer left a comment

Choose a reason for hiding this comment

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

I like the new naming better.

Copy link
Contributor

@Jimbo4350 Jimbo4350 left a comment

Choose a reason for hiding this comment

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

💯 just one comment however

@@ -125,19 +134,19 @@ forEraInEon :: ()
forEraInEon era no yes =
inEonForEra no yes era

inEraEonMaybe :: ()
forEraInEonMaybe :: ()
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

@newhoggy newhoggy added this pull request to the merge queue Sep 29, 2023
Merged via the queue into main with commit 4bf96a1 Sep 29, 2023
20 checks passed
@newhoggy newhoggy deleted the newhoggy/rename-eon-functions branch September 29, 2023 01:16
newhoggy pushed a commit that referenced this pull request Mar 11, 2024
…p-text

Fix typo in stake-pool help text and clarify drep queries arguments
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.

None yet

3 participants