cosmos-sdk/types
Amaury 0a3660d2ac
chore: Add "Since:" on proto doc comments (#10434)
<!--
The default pull request template is for types feat, fix, or refactor.
For other templates, add one of the following parameters to the url:
- template=docs.md
- template=other.md
-->

## Description

ref: https://github.com/cosmos/cosmos-sdk/discussions/10406#discussioncomment-1533289

For clients to know whether a protobuf feature is available for a certain SDK version, we decided to use the [`@since` doc comment](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#@since) inside protobuf files.

<!-- Add a description of the changes that this PR introduces and the files that
are the most critical to review. -->

---

### 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] 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](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)
2021-10-27 14:13:35 +00:00
..
address feat!: Add bech32 prefix to authkeeper (#9759) 2021-08-25 11:17:18 +00:00
bech32 build(deps): Use self-maintained btcutil (#10082) (#10201) 2021-09-30 13:25:44 +00:00
errors feat: Add Table-Store (aka ORM) package - `AutoUInt64Table` and `PrimaryKeyTable` (#10415) 2021-10-27 12:49:37 +00:00
grpc
kv fix: check store keys length before accessing (#9639) 2021-07-08 13:29:12 +02:00
module chore(upgrade): cleaning (#10413) 2021-10-22 10:56:08 +00:00
msgservice
query chore: Add "Since:" on proto doc comments (#10434) 2021-10-27 14:13:35 +00:00
simulation refactor: Rename x/{mod}/legacy to x/{mod}/migrations (#9628) 2021-07-05 14:55:51 +00:00
tx chore: Add "Since:" on proto doc comments (#10434) 2021-10-27 14:13:35 +00:00
abci.go
abci.pb.go refactor: Implementing sigs.k8s.io YAML to remove .proto yaml annotations (#9780) 2021-09-24 14:37:34 +00:00
address.go refactor: Implementing sigs.k8s.io YAML to remove .proto yaml annotations (#9780) 2021-09-24 14:37:34 +00:00
address_race_test.go
address_test.go refactor: Implementing sigs.k8s.io YAML to remove .proto yaml annotations (#9780) 2021-09-24 14:37:34 +00:00
bench_test.go
codec.go
coin.go perf: Only do memory allocation when zero coin is found (#10339) 2021-10-13 22:12:20 +00:00
coin.pb.go feat: Introduce Cosmos Scalars (#9933) 2021-09-21 09:46:29 +00:00
coin_benchmark_test.go test: fix BenchmarkCoinsAdditionIntersect panic (#9904) 2021-08-11 02:13:17 -07:00
coin_internal_test.go
coin_test.go fix: null guard for tx fee amounts (#10327) 2021-10-12 09:11:14 +00:00
config.go
config_test.go
context.go refactor: Remove store type aliases (#10295) 2021-10-04 16:36:38 +00:00
context_test.go feat: add header hash to `Context` (#9390) 2021-05-26 08:36:42 +00:00
dec_coin.go chore: change the inconsistent error message in DecCoin.ParseDecCoin func (#9831) 2021-09-14 14:43:12 +00:00
dec_coin_test.go chore: change the inconsistent error message in DecCoin.ParseDecCoin func (#9831) 2021-09-14 14:43:12 +00:00
decimal.go fix: Handle MAX_INT_256 (#9511) 2021-06-16 14:18:02 +00:00
decimal_internal_test.go
decimal_test.go refactor: Implementing sigs.k8s.io YAML to remove .proto yaml annotations (#9780) 2021-09-24 14:37:34 +00:00
denom.go
denom_internal_test.go
events.go feat: add tx fee event (#9860) 2021-08-09 14:50:01 +00:00
events_test.go
handler.go
handler_test.go refactor!: Keyring migration (#9695) 2021-09-20 12:02:15 +00:00
int.go types: fix nil pointer panic on `NewIntFromBigInt` (#9627) 2021-07-05 08:36:35 -04:00
int_internal_test.go fix: Handle MAX_INT_256 (#9511) 2021-06-16 14:18:02 +00:00
int_test.go types: fix nil pointer panic on `NewIntFromBigInt` (#9627) 2021-07-05 08:36:35 -04:00
invariant.go
invariant_test.go
proto.go
queryable.go
result.go refactor: Implementing sigs.k8s.io YAML to remove .proto yaml annotations (#9780) 2021-09-24 14:37:34 +00:00
result_test.go
router.go
router_test.go
staking.go
staking_test.go
store.go refactor: Remove store type aliases (#10295) 2021-10-04 16:36:38 +00:00
store_internal_test.go refactor: Remove store type aliases (#10295) 2021-10-04 16:36:38 +00:00
store_test.go refactor: Remove store type aliases (#10295) 2021-10-04 16:36:38 +00:00
tx_msg.go refactor!: change GetSigners return type to []sdk.AccAddress (#9915) 2021-08-13 15:34:00 +00:00
tx_msg_test.go refactor!: change GetSigners return type to []sdk.AccAddress (#9915) 2021-08-13 15:34:00 +00:00
uint.go
uint_internal_test.go
uint_test.go
utils.go
utils_test.go