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

feat(collections): add alternative value codec #16773

Merged
merged 7 commits into from
Jul 4, 2023

Conversation

testinginprod
Copy link
Contributor

Description

Closes: #16771


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@testinginprod testinginprod marked this pull request as ready for review June 29, 2023 15:16
@testinginprod testinginprod requested a review from a team as a code owner June 29, 2023 15:16
@github-prbot github-prbot requested review from a team, aaronc and julienrbrt and removed request for a team June 29, 2023 15:17
@tac0turtle
Copy link
Member

Could we get a few docs in this feature as well

@testinginprod
Copy link
Contributor Author

Could we get a few docs in this feature as well

docs added 👍

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

lgtm! However, I feel like the API does not convey immediately what it does.
I find the word “alternative”, while it is more a fallback, a bit confusing, just my two cents, however.

@testinginprod
Copy link
Contributor Author

lgtm! However, I feel like the API does not convey immediately what it does. I find the word “alternative”, while it is more a fallback, a bit confusing, just my two cents, however.

We can change the name if you feel it does not express well its role. I'm open to suggestions!

@julienrbrt
Copy link
Member

lgtm! However, I feel like the API does not convey immediately what it does. I find the word “alternative”, while it is more a fallback, a bit confusing, just my two cents, however.

We can change the name if you feel it does not express well its role. I'm open to suggestions!

I do not have a better suggestion 😅, it was simply not immediately clear for me what "alternative" meant by just reading the function arguments (without reading it or the godoc).

@testinginprod testinginprod added this pull request to the merge queue Jul 4, 2023
@testinginprod
Copy link
Contributor Author

@julienrbrt I think we can merge as is, worst case we can break this API, anyways it's intended for super advanced use-cases so I don't think a regular developer will really have to deal with this.

Merged via the queue into main with commit 309ed1a Jul 4, 2023
@testinginprod testinginprod deleted the tip/collections_lazy_value branch July 4, 2023 12:42
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.

feat(collections): Alternative ValueCodec
5 participants