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] Add What's Here for Complex #9366

Merged
merged 7 commits into from
Dec 28, 2023
Merged

[DOC] Add What's Here for Complex #9366

merged 7 commits into from
Dec 28, 2023

Conversation

BurdetteLamar
Copy link
Member

No description provided.

@BurdetteLamar BurdetteLamar added the Documentation Improvements to documentation. label Dec 26, 2023
complex.c Outdated
* and {Object}[rdoc-ref:Object@What-27s Here].
* - Includes (directly or indirectly)
* modules {Comparable}[rdoc-ref:Comparable@What-27s Here]
* and {Kernel}[rdoc-ref:Kernel@What-27s Here].
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure why we need to specify that Complex includes Kernel. Every object includes Kernel, but the methods of Kernel are private.

complex.c Outdated Show resolved Hide resolved
complex.c Outdated Show resolved Hide resolved
complex.c Show resolved Hide resolved
BurdetteLamar and others added 4 commits December 27, 2023 10:35
complex.c Outdated
*
* Here, class \Complex has methods for:
*
* - Creating \Complex objects:
Copy link
Member

Choose a reason for hiding this comment

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

I noticed that other docs (e.g. Array, Hash, Range) use subtitles instead of bullet points. Should we do that here too for consistency?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

@peterzhu2118 peterzhu2118 merged commit 0990270 into ruby:master Dec 28, 2023
24 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.
Development

Successfully merging this pull request may close these issues.

2 participants