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

Use annotations instead of // Since XX comment #20084

Closed
julienrbrt opened this issue Apr 18, 2024 · 2 comments · Fixed by #20098
Closed

Use annotations instead of // Since XX comment #20084

julienrbrt opened this issue Apr 18, 2024 · 2 comments · Fixed by #20098
Assignees
Labels
C: Proto Proto definition and proto release good first issue

Comments

@julienrbrt
Copy link
Member

julienrbrt commented Apr 18, 2024

Rewrite all // Since comments in our proto files as cosmos_proto.method_added_in, cosmos_proto.field_added_in, etc..

Example:

Then re-generate all protos (using make proto-gen)

Troubleshot `make proto-gen`

You may find issues when doing a buf mod update in each folder until #19503 is completed. Instead, simply update each relevant buf.lock as follows:

    owner: cosmos
    repository: cosmos-proto
    - commit: 1935555c206d4afb9e94615dfd0fad31
    - digest: shake256:c74d91a3ac7ae07d579e90eee33abf9b29664047ac8816500cf22c081fec0d72d62c89ce0bebafc1f6fec7aa5315be72606717740ca95007248425102c365377
    +  commit: 04467658e59e44bbb22fe568206e1f70
    + digest: shake256:73a640bd60e0c523b0f8237ff34eab67c45a38b64bbbde1d80224819d272dbf316ac183526bd245f994af6608b025f5130483d0133c5edd385531326b5990466

Follow-up of #20083 and cosmos/cosmos-proto#133

@minhngoc274
Copy link
Contributor

Hi @julienrbrt , we just push a pr for this issue, please take a look, thank you

@julienrbrt
Copy link
Member Author

julienrbrt commented Apr 24, 2024

Answering #20167 (comment) here.
I don't think it is useful to denote this, imho. Enums need to be used somewhere, and they will be mostly denoted in message added in or field added in.

Feel free to just remove that comment.

cc @tropicaldog

@github-project-automation github-project-automation bot moved this from 📋 Backlog to 🥳 Done in Cosmos-SDK Apr 26, 2024
@tac0turtle tac0turtle removed this from Cosmos-SDK Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: Proto Proto definition and proto release good first issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants