-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rework Object getter, setter and property docs #15428
Open
ysbaddaden
wants to merge
3
commits into
crystal-lang:master
Choose a base branch
from
ysbaddaden:refactor/object-property-docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Rework Object getter, setter and property docs #15428
ysbaddaden
wants to merge
3
commits into
crystal-lang:master
from
ysbaddaden:refactor/object-property-docs
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
@@ -0,0 +1,619 @@ | |||
# WARNING: THIS FILE HAS BEEN AUTOGENERATED BY scripts/generate_object_properties.cr |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All auto-generated files should have a corresponding .gitattributes entry
ysbaddaden
commented
Feb 7, 2025
Comment on lines
305
to
306
# @@backend : String | ||
# |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
# @@backend : String | |
# |
…l-lang#15386) Generates the macros from an external script that will inline the actual macro implementations, instead of using macros to generate the macros and duplicating the actual implementation multiple times.
ysbaddaden
added a commit
to ysbaddaden/crystal
that referenced
this pull request
Feb 7, 2025
15ed857
to
e21a5cd
Compare
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 Object itself, with references to the different variants. Then each macro has a smaller description of what 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