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

Add older eras deprecation notice. #879

Merged

Conversation

carbolymer
Copy link
Contributor

@carbolymer carbolymer commented Aug 30, 2024

Changelog

- description: |
    Add for eras <= Babbage a deprecation notice.
# 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

Additional context for the PR goes here. If the PR fixes a particular issue please provide a link to the issue.

How to trust this PR

Highlight important bits of the PR that will make the review faster. If there are commands the reviewer can run to observe the new behavior, describe them.

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

@carbolymer carbolymer force-pushed the mgalazyn/feature/add-older-eras-deprecation-notice branch from fa2fb6d to fc4f649 Compare September 2, 2024 08:50
@carbolymer carbolymer changed the title Add older eras deprecation notice Make Conway era default. Add older eras deprecation notice. Sep 2, 2024
@carbolymer carbolymer marked this pull request as ready for review September 2, 2024 08:52
@carbolymer carbolymer force-pushed the mgalazyn/feature/add-older-eras-deprecation-notice branch 2 times, most recently from 89ab15b to df3f3a6 Compare September 2, 2024 09:49
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.

LGTM but a couple of comments to consider


defaultShelleyToBabbageEra :: EraInEon ShelleyToBabbageEra
defaultShelleyToBabbageEra = EraInEon ShelleyToBabbageEraBabbage
defaultShelleyBasedEra = EraInEon ShelleyBasedEraConway
Copy link
Contributor

Choose a reason for hiding this comment

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

This is fine for now but I think we should demand the user specify the era. Otherwise we have to plan a release around this value which is cumbersome.

Copy link
Contributor Author

@carbolymer carbolymer Sep 2, 2024

Choose a reason for hiding this comment

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

100%. Actually, this default value is used only in legacy hierarchy, so actually this change is wrong. We don't want to change a default there. I'll revert to Babbage.

@carbolymer carbolymer force-pushed the mgalazyn/feature/add-older-eras-deprecation-notice branch 2 times, most recently from 40394a3 to 26061be Compare September 2, 2024 17:37
@carbolymer carbolymer force-pushed the mgalazyn/feature/add-older-eras-deprecation-notice branch from 26061be to 25fcdff Compare September 2, 2024 17:47
@carbolymer carbolymer changed the title Make Conway era default. Add older eras deprecation notice. Add older eras deprecation notice. Sep 2, 2024
@carbolymer carbolymer added this pull request to the merge queue Sep 2, 2024
Merged via the queue into main with commit c9fbcda Sep 2, 2024
28 checks passed
@carbolymer carbolymer deleted the mgalazyn/feature/add-older-eras-deprecation-notice branch September 2, 2024 19:25
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