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

CI: Drop redundant no-default-features from docs and test private items #673

Merged
merged 1 commit into from
Oct 11, 2023

Conversation

MarijnS95
Copy link
Contributor

I added --all-features in #670 without removing --no-default-features which now has no effect anymore.

In addition it is useful to make sure that documentation on private items also adheres to valid intradoc, and somewhat strangely enabling this also causes additional lint warnings on public documentation...

@MarijnS95
Copy link
Contributor Author

…tems

I added `--all-features` in algesten#670 without removing `--no-default-features`
which now has no effect anymore.

In addition it is useful to make sure that documentation on private items
also adheres to valid intradoc, and somewhat strangely enabling this also
causes additional lint warnings on public documentation...
@algesten
Copy link
Owner

How would private items interact with #![deny(missing_docs)]?

I would like us to have #![deny(missing_docs)], but I don't want to force us to document private items.

@MarijnS95
Copy link
Contributor Author

@algesten this lint is enforced by rustdoc (as well as rustc: https://doc.rust-lang.org/rustdoc/lints.html) but only for public items even when passing --no-default-features. It is only complaining about 2 public type aliases, 7 public functions and 1 public trait that is undocumented 🎉

Note that if you're doing this, the crate might as well have pass for missing backticks and intradoc links, as I did for one comment in this PR :)

@algesten
Copy link
Owner

Alright. Let's do it!

@algesten algesten merged commit d4abcfc into algesten:main Oct 11, 2023
41 checks passed
@MarijnS95 MarijnS95 deleted the ci-doc-cleanup branch October 11, 2023 12:31
@MarijnS95
Copy link
Contributor Author

MarijnS95 commented Oct 11, 2023

Can always revert if it turns out to cause future issues/limitations, but I doubt it 🙂

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.

2 participants