Skip to content

Missing documentation for associated constant #14

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

Open
zheylmun opened this issue Mar 25, 2025 · 3 comments
Open

Missing documentation for associated constant #14

zheylmun opened this issue Mar 25, 2025 · 3 comments

Comments

@zheylmun
Copy link

Any crate using:
#![deny(missing_docs)
immediately runs into an issue because the associated constants for the bit sizes and offsets do not have associated doc comments.

My feeling is that the right answer is to simply remove the pub from the const declarations, but I wanted to ask your opinion before opening a PR.

I feel like those definitions are implementation details that likely don't need to be exposed.

@gregorygaines
Copy link
Owner

gregorygaines commented Mar 25, 2025 via email

@gregorygaines
Copy link
Owner

gregorygaines commented Apr 22, 2025

Hello @zheylmun, how about we document the types instead?

@gregorygaines
Copy link
Owner

Fixed in the updated release:

[dependencies]
bitfields = "0.13.1"

Let me know what you think.

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 a pull request may close this issue.

2 participants