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

Add missing documentation for from_bits() and into_bits() #37

Merged
merged 1 commit into from
May 17, 2024

Conversation

osteffenrh
Copy link
Contributor

Fix warnings about missing documentation if #![warn(missing_docs)] is enabled.

For example:

warning: missing documentation for a method
   --> xxx/src/lib.rs:654:1
    |
654 | #[bitfield(u32)]
    | ^^^^^^^^^^^^^^^^ in this procedural macro expansion
    |
   ::: /home/xxx/.cargo/registry/src/index.crates.io-6f17d22bba15001f/bitfield-struct-0.6.1/src/lib.rs:39:1
    |
39  | pub fn bitfield(args: pc::TokenStream, input: pc::TokenStream) -> pc::TokenStream {
    | --------------------------------------------------------------------------------- in this expansion of `#[bitfield]`

Fix warnings about missing documentation if `#![warn(missing_docs)]` is
enabled.

Signed-off-by: Oliver Steffen <[email protected]>
@wrenger
Copy link
Owner

wrenger commented May 17, 2024

Ah, thanks for catching and documenting this.

@wrenger wrenger merged commit 3081cf9 into wrenger:main May 17, 2024
3 checks passed
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