Fix doc comment for exception::line_number() #901
Merged
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
The documentation comment for `exception::line_number()` in `include/etl/exception.h` states falsely that the return type for the function is a `const char*`. It should state that the return type is `numeric_type`, which is an `int`. So change the documentation comment to reflect that the return type is an `int`.
|
Review changes with SemanticDiff. |
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.
The documentation comment for
exception::line_number()ininclude/etl/exception.hstates falsely that the return type for the function is aconst char*. It should state that the return type isnumeric_type, which is anint. So change the documentation comment to reflect that the return type is anint.I know that this is a small issue but when I'm setting up error handling for ETL it just irks me to have my IDE report false data.