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
[DOC] Improve doc guide compliance #8221
Conversation
@peterzhu2118, why are we having more than one class/module defined in a file? It makes this operation (and perhaps others) more difficult. |
Some classes need to share internal implementation in the C code, so they live in the same file. Unfortunately we can't resolve this issue without some (possibly significant) refactors in the C code. |
object.c
Outdated
* These are the methods defined for BasicObject: | ||
* | ||
* - ::new: Returns a new \BasicObject instance. | ||
* - ::new: Returns a new BasicObject instance. |
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.
This is documentation for the BasicObject class.
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.
Fixed.
Co-authored-by: Peter Zhu <peter@peterzhu.ca>
Avoid suppressing autolinks to classes and modules.
I think this is the last for ruby/*.{c,rb}. Everything else is upstream, right?