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

More documentation for methods in RDoc #1111

Open
okuramasafumi opened this issue May 25, 2024 · 0 comments
Open

More documentation for methods in RDoc #1111

okuramasafumi opened this issue May 25, 2024 · 0 comments

Comments

@okuramasafumi
Copy link
Contributor

okuramasafumi commented May 25, 2024

Problem

When I look into a source code of RDoc to debug, it's so hard to read it due to the lack of proper documentation.
For example, https://github.com/ruby/rdoc/blob/master/lib/rdoc/parser.rb#L254 has 5 parameters and I don't know what content is at all. And options is usually a Hash in other gems, but here RDoc::Options instance is expected.
While we can guess some of them, it's not ideal.

Suggestion

My proposal is to add more comments to existing source code of RDoc. This will help us read it better, understand it better and improve it better.
I'd appreciate it if current maintainers do this since they understand the structure of the code well, I could do this as well.

Misc

The documentation format will be RDoc format.

Other ideas

Or, it might be worth adding types to RDoc.

@okuramasafumi okuramasafumi changed the title Document RDoc itself More documentation for methods in RDoc May 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant