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

Tried adding rustdoc args to no effect :-/ #154

Closed
carols10cents opened this issue Sep 9, 2017 · 3 comments
Closed

Tried adding rustdoc args to no effect :-/ #154

carols10cents opened this issue Sep 9, 2017 · 3 comments

Comments

@carols10cents
Copy link
Member

It's entirely possible we're doing something wrong, but I don't know what that something could be.

We're trying to document private items on crates.io's library crate, cargo_registry. We've specified this in Cargo.toml:

[project.metadata.docs.rs]
rustdoc-args = ["--no-defaults --passes collapse-docs --passes unindent-comments"]

And then published version 0.2.0, but I don't see private things like the DOCUMENTATION_BLACKLIST constant in the docs :(

When I run this command locally, I do see the private items in the generated docs:

cargo rustdoc --lib -- --no-defaults --passes collapse-docs --passes unindent-comments

Thanks!

@onur
Copy link
Member

onur commented Sep 9, 2017

sorry @carols10cents I forgot to mention in that pull request, @mattgathu actually changed package.metadata.docs.rs to project.metadata.docs.rs. That has no effect on docs.rs. You can see his comment here. Docs.rs only works with package.metadata.docs.rs.

@onur
Copy link
Member

onur commented Sep 9, 2017

I've sent a PR, it should solve this issue.

@onur
Copy link
Member

onur commented Sep 11, 2017

This issue is resolved now, cargo-registry have documentation of private types.

@onur onur closed this as completed Sep 11, 2017
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