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

Consider renaming container.Option #11917

Closed
Tracked by #11899
aaronc opened this issue May 10, 2022 · 3 comments
Closed
Tracked by #11899

Consider renaming container.Option #11917

aaronc opened this issue May 10, 2022 · 3 comments
Assignees

Comments

@aaronc
Copy link
Member

aaronc commented May 10, 2022

When working with the container, Option seems like a weird name for what this does. It's really the core set of instructions to build the container. Maybe Config or Initializer?

@facundomedica
Copy link
Member

facundomedica commented May 10, 2022

+1 on Config, which looks consistent with what we have in other places in the SDK

EDIT: nvm, I'm not sure on this one after looking more into the code. Config sounds like a thing only done once

@kocubinski
Copy link
Member

kocubinski commented May 23, 2022

How about Behavior or Trait?

@aaronc
Copy link
Member Author

aaronc commented May 23, 2022

Sort of leaning towards Config because it's a simple and common word

mergify bot pushed a commit that referenced this issue May 24, 2022
## Description

Ref: #11917

The noun should be one which conveys the notion of a *core instruction*.  Other names for this type I've considered:

- Instruction
- Behavior
- Specification
- [Config](#11917 (comment)) (probably the most straighforward)
-  Trait



---

### 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...

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [x] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules)
- [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing)
- [x] added a changelog entry to `CHANGELOG.md`
- [x] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [x] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [x] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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)
Repository owner moved this from 📝 Todo to 👏 Done in Cosmos-SDK May 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

4 participants