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

Maybe hide some implementation details? #6

Open
mnishiguchi opened this issue Jan 16, 2022 · 4 comments
Open

Maybe hide some implementation details? #6

mnishiguchi opened this issue Jan 16, 2022 · 4 comments

Comments

@mnishiguchi
Copy link
Contributor

mnishiguchi commented Jan 16, 2022

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?

@tashirosota
Copy link
Owner

Nice idea!I agree it.

When @moduledoc false, the link is broken in top level module REnum
スクリーンショット 2022-01-17 9 46 35
It's hard if writes all docs to top level module...
I don't know other way.
Do you know any good way?

@mnishiguchi
Copy link
Contributor Author

I had the same issue before. We cannot use the docs of hidden modules. Let me find some info...

@mnishiguchi
Copy link
Contributor Author

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.
The benefit of the meta programming is huge here and all looks cleanly organized 👍

@tashirosota
Copy link
Owner

@mnishiguchi
Thank you for looking for another way.
If possible, I would like to display only top level modules, so if I find a good way to do it in the future, I would love to do so!
Leave this issue as it is!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants