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 distinction of Metadata struct and internal metadata field #532

Merged
merged 2 commits into from
Apr 13, 2023

Conversation

haerdib
Copy link
Contributor

@haerdib haerdib commented Apr 13, 2023

To make it more obvious to the user what's the difference between Metadata and metadata the following is updated:

  • renamed metadata to runtime_metadata
  • Added explanatory comment to Metadatastruct
  • pretty_format now takes self as argument and returns an error instead of an Option (which resulted in information loss in case of an error)

closes #493

@haerdib haerdib self-assigned this Apr 13, 2023
@haerdib haerdib added F7-enhancement Enhances an already existing functionality E2-breaksapi and removed F7-enhancement Enhances an already existing functionality labels Apr 13, 2023
@haerdib haerdib changed the title Rename metadata to runtime_metadata Clarify distinction of Metadata struct and internal metadata field Apr 13, 2023
@haerdib haerdib marked this pull request as ready for review April 13, 2023 07:43
Copy link
Contributor

@echevrier echevrier left a comment

Choose a reason for hiding this comment

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

Nice. Small but really useful changes

Copy link
Contributor

@Niederb Niederb left a comment

Choose a reason for hiding this comment

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

Great 🎈

@haerdib haerdib merged commit 7b96370 into master Apr 13, 2023
@haerdib haerdib deleted the bh/rename-metadata branch April 13, 2023 08:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make Metadata struct more intuitive
3 participants