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

Simplify features and make documentation call out feature gates #1479

Merged
merged 5 commits into from
Feb 3, 2025

Conversation

akern40
Copy link
Collaborator

@akern40 akern40 commented Feb 2, 2025

This closes #1470 by getting rid of the serde-1, test, and docs features to show a better interface to users. In addition, this uses the same technique that tokio uses to add the feature gating that you see in docs.rs - for example, see the spawn documentation.

…ure-gated items as requiring that feature.

This is possible thanks to the fact that docs.rs runs on nightly. While this may not be stabilized (and therefore may eventually reverse), I think it's extremely useful to users and only requires small additional configurations that would be easy to remove in the future.
@akern40 akern40 marked this pull request as ready for review February 2, 2025 20:51
@akern40 akern40 merged commit c7391e9 into rust-ndarray:master Feb 3, 2025
14 checks passed
@akern40 akern40 deleted the docs-and-features branch February 3, 2025 04:54
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 this pull request may close these issues.

Confusing Features
1 participant