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

[DOC] Improve doc guide compliance #8221

Merged
merged 4 commits into from Aug 15, 2023
Merged

[DOC] Improve doc guide compliance #8221

merged 4 commits into from Aug 15, 2023

Conversation

BurdetteLamar
Copy link
Member

Avoid suppressing autolinks to classes and modules.

I think this is the last for ruby/*.{c,rb}. Everything else is upstream, right?

@BurdetteLamar BurdetteLamar added the Documentation Improvements to documentation. label Aug 15, 2023
object.c Outdated Show resolved Hide resolved
re.c Outdated Show resolved Hide resolved
struct.c Outdated Show resolved Hide resolved
struct.c Outdated Show resolved Hide resolved
struct.c Outdated Show resolved Hide resolved
@BurdetteLamar
Copy link
Member Author

@peterzhu2118, why are we having more than one class/module defined in a file? It makes this operation (and perhaps others) more difficult.

@peterzhu2118
Copy link
Member

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
Comment on lines 4146 to 4148
* These are the methods defined for BasicObject:
*
* - ::new: Returns a new \BasicObject instance.
* - ::new: Returns a new BasicObject instance.
Copy link
Member

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

object.c Outdated Show resolved Hide resolved
Co-authored-by: Peter Zhu <peter@peterzhu.ca>
@peterzhu2118 peterzhu2118 merged commit 8c5b9eb into ruby:master Aug 15, 2023
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements to documentation.
2 participants