fix: remove comment about default value (#2867) #3000
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ValarDragon
approved these changes
May 3, 2024
|
Thanks @ValarDragon |
melekes
approved these changes
May 4, 2024
mergify bot
pushed a commit
that referenced
this pull request
May 6, 2024
Related to #2867 Quick fix for a comment in the code added about a default value for a config parameter. During backport to `v0.38.x`, @melekes made a suggestion that the default value in a comment was inaccurate. Instead of updating the default value in the comment, I've decided to remove the comment about the default value. In my opinion, we should not have default value for config parameters in comments if it's clear specified in the configuration docs what are the default and possible values. Realized that having the default values in comments is not beneficial and updating in the comment might be a not as straightforward as changing it in code/config. #### PR checklist - [ ] ~~Tests written/updated~~ - [ ] ~~Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog)~~ - [X] Updated relevant documentation (`docs/` or `spec/`) and code comments - [X] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec (cherry picked from commit cac1fd8)
mergify bot
pushed a commit
that referenced
this pull request
May 6, 2024
Related to #2867 Quick fix for a comment in the code added about a default value for a config parameter. During backport to `v0.38.x`, @melekes made a suggestion that the default value in a comment was inaccurate. Instead of updating the default value in the comment, I've decided to remove the comment about the default value. In my opinion, we should not have default value for config parameters in comments if it's clear specified in the configuration docs what are the default and possible values. Realized that having the default values in comments is not beneficial and updating in the comment might be a not as straightforward as changing it in code/config. #### PR checklist - [ ] ~~Tests written/updated~~ - [ ] ~~Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog)~~ - [X] Updated relevant documentation (`docs/` or `spec/`) and code comments - [X] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec (cherry picked from commit cac1fd8) # Conflicts: # rpc/jsonrpc/server/http_server.go
This was referenced May 6, 2024
melekes
added a commit
that referenced
this pull request
May 6, 2024
Related to #2867 Quick fix for a comment in the code added about a default value for a config parameter. During backport to `v0.38.x`, @melekes made a suggestion that the default value in a comment was inaccurate. Instead of updating the default value in the comment, I've decided to remove the comment about the default value. In my opinion, we should not have default value for config parameters in comments if it's clear specified in the configuration docs what are the default and possible values. Realized that having the default values in comments is not beneficial and updating in the comment might be a not as straightforward as changing it in code/config. #### PR checklist - [ ] ~~Tests written/updated~~ - [ ] ~~Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog)~~ - [X] Updated relevant documentation (`docs/` or `spec/`) and code comments - [X] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec <hr>This is an automatic backport of pull request #3000 done by [Mergify](https://mergify.com). --------- Co-authored-by: Andy Nogueira <me@andynogueira.dev> Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>
melekes
added a commit
that referenced
this pull request
May 6, 2024
Related to #2867 Quick fix for a comment in the code added about a default value for a config parameter. During backport to `v0.38.x`, @melekes made a suggestion that the default value in a comment was inaccurate. Instead of updating the default value in the comment, I've decided to remove the comment about the default value. In my opinion, we should not have default value for config parameters in comments if it's clear specified in the configuration docs what are the default and possible values. Realized that having the default values in comments is not beneficial and updating in the comment might be a not as straightforward as changing it in code/config. #### PR checklist - [ ] ~~Tests written/updated~~ - [ ] ~~Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog)~~ - [X] Updated relevant documentation (`docs/` or `spec/`) and code comments - [X] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec <hr>This is an automatic backport of pull request #3000 done by [Mergify](https://mergify.com). Co-authored-by: Andy Nogueira <me@andynogueira.dev> Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to #2867
Quick fix for a comment in the code added about a default value for a config parameter.
During backport to
v0.38.x, @melekes made a suggestion that the default value in a comment was inaccurate. Instead of updating the default value in the comment, I've decided to remove the comment about the default value.In my opinion, we should not have default value for config parameters in comments if it's clear specified in the configuration docs what are the default and possible values. Realized that having the default values in comments is not beneficial and updating in the comment might be a not as straightforward as changing it in code/config.
PR checklist
Tests written/updatedChangelog entry added in.changelog(we use unclog to manage our changelog)docs/orspec/) and code comments