Skip to content

[DOC] Remark on including the module#94

Closed
BurdetteLamar wants to merge 1 commit intoruby:masterfrom
BurdetteLamar:rdoc
Closed

[DOC] Remark on including the module#94
BurdetteLamar wants to merge 1 commit intoruby:masterfrom
BurdetteLamar:rdoc

Conversation

@BurdetteLamar
Copy link
Member

No description provided.

Copy link
Member

@peterzhu2118 peterzhu2118 left a comment

Choose a reason for hiding this comment

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

I don't we should include this section. Most users should call the method from the module (like FileUtils.pwd). I don't think including all the methods is a best practice so I don't think we should encourage users to do it. If they do want to do something like that, they should know what they're doing and not have to refer to this kind of documentation.

@BurdetteLamar
Copy link
Member Author

Agreed; not good practice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants