Skip to content
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
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

ysbaddaden
Copy link
Contributor

@ysbaddaden ysbaddaden commented Feb 7, 2025

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

@ysbaddaden ysbaddaden self-assigned this Feb 7, 2025
@@ -0,0 +1,619 @@
# WARNING: THIS FILE HAS BEEN AUTOGENERATED BY scripts/generate_object_properties.cr
Copy link
Contributor

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

Comment on lines 305 to 306
# @@backend : String
#
Copy link
Contributor Author

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants