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

Add links to crates.io and docs.rs for the main crate to the website? #53

Open
tatterhood opened this issue Oct 11, 2024 · 2 comments
Open

Comments

@tatterhood
Copy link

The crates.io pages for all the subcrates recommend against using them in favour of the main malachite crate. Given this, it seems a little strange that (unless I've missed something) the website has links to crates.io and docs.rs for the subcrates but not for the main crate.

(It would be nice to have these links in the github readme, too.)

@mhogrefe
Copy link
Owner

mhogrefe commented Jan 25, 2025

These are good points.

Originally, there was no main malachite crate, just malachite-base, malachite-nz, etc. I added the supercrate based on someone's suggestion, but I mostly just use the individual crates and haven't thought about the supercrate much. As you noticed, this lack of attention has led to an odd user experience.

I just released v0.4.18, added the links you suggested, and removed the docs.rs links to the individual crates. There are still some weird things that I want to fix:

  • The malachite-base modules are at the wrong level; we have the conversion module at the same level as natural module, with natural/conversion one level below. I will fix this so that the top-level modules are base, natural, integer, and rational, with base/conversion, natural/conversion, etc. one level below.
  • The doctests all import the individual crates, even though using the supercrate should be probably be the recommended option, and this should be reflected in the doctests.

I will keep this issue open to update with my progress on these improvements.

@mhogrefe
Copy link
Owner

In v0.4.21 I changed the malachite-base items to be re-exported under a base module.

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