-
Notifications
You must be signed in to change notification settings - Fork 4
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
Maybe hide some implementation details? #6
Comments
I had the same issue before. We cannot use the docs of hidden modules. Let me find some info... |
Hmmm I cannot find a way to hide modules nicely so far... I guess after all it is GOOD AS IS. At first I just thought the docs could be compact somehow. |
@mnishiguchi |
It is a matter of design decision. So it is just an idea.
Currently the library exposes all the implementation details. I have a feeling that what users want is the top-level module and its functions. If we hide all the potentially-private modules, the documentation could be simpler. Then we can explain about each of the top-level functions in their
@doc
.In other words, do the users need to know about
REnum.Native
,REnum.Ruby
, etc?The text was updated successfully, but these errors were encountered: