update: Add section about constructor parameters and properties in classes #4872
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
choonkending
changed the title
choonkending
changed the title
|
Bumping this PR - it's not high priority but something valuable imo. Let me know if you reckon it should be reworded/clarified further. |
sarahhaggarty
requested changes
Jun 30, 2025
There was a problem hiding this comment.
Thanks for your suggestion @choonkending ! Sorry it took so long to get to your PR. Your text is correct but could do with some expansion so I made a suggestion. Let me know if you have any questions!
Include a brief explanation between the difference between constructor parameters and properties in the constructor.
Co-authored-by: Sarah Haggarty <[email protected]>
|
@sarahhaggarty Thank you very much for the suggestion. I've updated the commits to include your suggestion and followed the convention the other commits seem to be having. Let me know what else is required 🙏 |
sarahhaggarty
approved these changes
Jul 3, 2025
|
Great! Thanks for your contribution @choonkending ! |
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.
High Level Overview
KT-77990
When I was going through the documentation, I had a bit of confusion around "When would we include
valorvarvs when we shouldn't?" I could not really find it anywhere in the docs, hence I am proposing to include a section explaining the difference between parameters and properties in the constructor.While it may seem obvious, I hope this clarification can help!
I debated between making this it's own tiny section - but figured it flowed naturally from the current description of properties.
First time contributing to these docs, so happy for any feedback/correction/discussion.