Use constants for HTTP codes in documentation example #2362
Conversation
This file contains 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
For constant values, descriptive constants must be used. Not the values directly.
|
also, looks like the tests are corrupt (the tests should not fail after just one line change in a documentation I guess?) |
|
When the numbers come from standards like HTTP, we prefer the actual value. |
|
why do you have a whole set of constants for HTTP codes in a Response class then? |
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
For constant values, descriptive constants must be used. Not the values directly.
A goal of documentation, aside from giving information to a developer, is also to encourage a developer to follow good coding practices. One of such practices is to use descriptive constants for constant values instead of using such values directly.