Rework Object getter, setter and property docs #15428
Open
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
HertzDevil
reviewed
Feb 7, 2025
ysbaddaden
commented
Feb 7, 2025
ysbaddaden
added a commit
to ysbaddaden/crystal
that referenced
this pull request
Feb 7, 2025
ysbaddaden
force-pushed
the
refactor/object-property-docs
branch
from
15ed857 to
e21a5cd
Compare
ysbaddaden
force-pushed
the
refactor/object-property-docs
branch
from
e21a5cd to
adff0b0
Compare
|
Rebased from master since #15386 got merged. |
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.
Initial rework of the documentation for Object getter, setter and property macros to avoid duplication and repetition.
A general description of the behavior has been added to
Objectitself, with references to the different variants. Then each macro has a smaller description on how it is different from the main behavior.Even if imperfect I believe it's a good start. Feel free to edit, modify and take over the PR as you see fit (or better: work on a follow up).
Follow up to #15386
Screenshot of what the general doc looks
Screenshot of what a macro doc looks