-
-
Notifications
You must be signed in to change notification settings - Fork 1
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
Comments
Go ahead!
…On Mon, Mar 24, 2025 at 9:28 PM Zach Heylmun ***@***.***> wrote:
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.
—
Reply to this email directly, view it on GitHub
<#14>, or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AFZOGAAMKFQNHXGHHT754Z32WCWNLAVCNFSM6AAAAABZWKKQPCVHI2DSMVQWIX3LMV43ASLTON2WKOZSHE2DIOBYHEYDANQ>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
[image: zheylmun]*zheylmun* created an issue
(gregorygaines/bitfields-rs#14)
<#14>
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.
—
Reply to this email directly, view it on GitHub
<#14>, or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AFZOGAAMKFQNHXGHHT754Z32WCWNLAVCNFSM6AAAAABZWKKQPCVHI2DSMVQWIX3LMV43ASLTON2WKOZSHE2DIOBYHEYDANQ>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
|
Hello @zheylmun, how about we document the types instead? |
Fixed in the updated release:
Let me know what you think. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The text was updated successfully, but these errors were encountered: