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.

Sign up for GitHub

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

Jump to bottom

RBS - RDoc Plugin #1048

Merged
merged 14 commits into from
Jul 27, 2022
Merged

RBS - RDoc Plugin #1048

merged 14 commits into from
Jul 27, 2022

Conversation

raosush
Copy link
Contributor

@raosush raosush commented Jun 24, 2022 •
edited
Loading

Description

  • Support for documentation generation from RBS files
  • Implementing the feature as a RDoc plugin

Changes

  • Added code for registering plugin while running RDoc
  • Added support for classes, modules, methods, constants, attributes, method aliases

Further Improvements

  • Support the AST::Declarations of RBS

@soutaro soutaro self-assigned this Jun 26, 2022
@raosush raosush force-pushed the rbs_rdoc_plugin branch 2 times, most recently from b75d380 to 350439f Compare July 1, 2022 07:40
raosush and others added 7 commits July 22, 2022 18:52
@raosush
Init commit
e6510f5 
- Added code required for RDoc plugin
- Currently documentation supported for classes, modules, constant, methods

Signed-off-by: Sushanth Sathesh Rao <57192414+raosush@users.noreply.github.com>
@raosush
Added support for more declarations
8c5f685 
- Attributes
- Method Alias

Added support for source code to be displayed in generated documentation
@raosush
Pass fully qualified name for modules
1f6e8fb
@raosush
Pass fully qualified name for modules.
215a923 
- Generate documentation for interfaces, included & extended modules
@raosush
Add signatures for RDoc code
cdd8459
@soutaro @raosush
Adding unit tests
f71aded 
* Refactored RDoc::Parser::RBS to make unit testing easier
* Adding some test cases

Co-authored-by: Sushanth Sathesh Rao <raosush@users.noreply.github.com>
@raosush
Unit Tests
5933b76 
- Added unit tests for all declarations
- Currently, classes, modules, methods, aliases, attributes, includes, extends are supported and have been tested
soutaro
soutaro requested changes Jul 23, 2022
View reviewed changes
Copy link
Member

@soutaro soutaro left a comment

Choose a reason for hiding this comment

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

🙏

stdlib/rdoc/0/rdoc.rbs Outdated Show resolved Hide resolved
lib/rdoc/parser/rbs.rb Outdated Show resolved Hide resolved
lib/rdoc/parser/rbs.rb Outdated Show resolved Hide resolved
test/rbs/rdoc/rbs_parser_test.rb Outdated Show resolved Hide resolved
test/rbs/rdoc/rbs_parser_test.rb Outdated Show resolved Hide resolved
test/rbs/rdoc/rbs_parser_test.rb Outdated Show resolved Hide resolved
soutaro and others added 4 commits July 25, 2022 00:32
@soutaro
Add comment for is_alias_for
7058f60
@raosush
Review fixes
23c3e5c 
- Move the parser to definition to `discover.rb`
- Move the rdoc plugin files to rdoc_plugin directory
- Rename files
- Rewrite signatures for the above changes
@raosush
Revert location change of discover.rb
ab68d80
@raosush
Delete empty teardown
b463e28
@raosush raosush requested a review from soutaro July 26, 2022 16:51
@soutaro soutaro marked this pull request as ready for review July 27, 2022 13:20
soutaro
soutaro approved these changes Jul 27, 2022
View reviewed changes
Copy link
Member

@soutaro soutaro left a comment

Choose a reason for hiding this comment

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

Thank you! 🎉

@soutaro soutaro merged commit 9cbd008 into ruby:master Jul 27, 2022
@raosush raosush deleted the rbs_rdoc_plugin branch July 28, 2022 10:03
@soutaro soutaro added this to the RBS 2.7.0 milestone Sep 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@soutaro soutaro soutaro approved these changes

Assignees

@soutaro soutaro

Labels
None yet
Milestone
RBS 2.7.0
Development

Successfully merging this pull request may close these issues.
2 participants
@raosush @soutaro