DOC: Avoid documenting ivar default values#202
Merged
jhlegarreta merged 1 commit intoInsightSoftwareConsortium:masterfrom Jul 17, 2023
Merged
Conversation
Avoid documenting ivar default values since: - All ivar values should be initialized to some default value. - When default values are changed, it is easy to forget about updating the documentation and making it inconsistent with the actual value in the code.
github-actions
bot
added
area:Appendices
3 tasks
dzenanz
approved these changes
Jul 17, 2023
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Avoid documenting ivar default values since: