Skip to content

Make the modules pub again and write module documents #48

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

Closed
qryxip opened this issue Sep 14, 2020 · 0 comments · Fixed by #50
Closed

Make the modules pub again and write module documents #48

qryxip opened this issue Sep 14, 2020 · 0 comments · Fixed by #50

Comments

@qryxip
Copy link
Member

qryxip commented Sep 14, 2020

In #6, we decided to make all of the modules crate-private.

But maybe we should make the mods pub again and write doc comments in each modules, as in the original ACL they split the description into modules.

Moreover, our ACL provides extra types/traits. They are unlikely used directly and they should be public (i.e. reachable). For example, user should be able to see modint::RemEuclidU32 is implemented for all of the primitive integers. They should be in each modules keeping their documents reachable.

Screenshot

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

Successfully merging a pull request may close this issue.

1 participant