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

remove 'IntoListReader' trait #349

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

danieleades
Copy link
Contributor

No description provided.

@dwrensha
Copy link
Member

This trait appears in user-facing API here:

T: IntoInternalListReader<'a>,

After this change, the private ListReader type would appear there instead, which I would prefer not to expose in such an API. I don't want users clicking on documentation links trying to understand this function, and ending up in the capnp::private namespace, where they usually don't need to be.

I've added a bit of documentation here: 636e4d5

@danieleades
Copy link
Contributor Author

This trait appears in user-facing API here:

T: IntoInternalListReader<'a>,

After this change, the private ListReader type would appear there instead, which I would prefer not to expose in such an API. I don't want users clicking on documentation links trying to understand this function, and ending up in the capnp::private namespace, where they usually don't need to be.

I've added a bit of documentation here: 636e4d5

Can you not hide the type using #[doc(hidden)]?

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.

None yet

2 participants