Skip to content

forbid(missing_docs) and nightly compiler#52

Draft
ounsworth wants to merge 28 commits into
bcgit:release/0.1.2alphafrom
ounsworth:feature/mikeo/missing_docs_and_nightly_compiler
Draft

forbid(missing_docs) and nightly compiler#52
ounsworth wants to merge 28 commits into
bcgit:release/0.1.2alphafrom
ounsworth:feature/mikeo/missing_docs_and_nightly_compiler

Conversation

@ounsworth

@ounsworth ounsworth commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

This PR stacks on top of #48

This PR is going to be a round-up of a bunch of docs changes and refactorings related to removing the nightly compiler requirement.

  • Remove dependence on nightly / unstable
  • All crates have #![forbid(missing_docs)] (and missing docs are added)

As a side-effect of removing nightly / unstable, I refactored how OIDs are carried for HashMLDSA to a more general trait in core, which actually is a much better design anyway.

@ounsworth ounsworth force-pushed the feature/mikeo/missing_docs_and_nightly_compiler branch from b29f36a to 1dc415b Compare July 9, 2026 03:28
@ounsworth ounsworth force-pushed the feature/mikeo/missing_docs_and_nightly_compiler branch from bacec5a to b1e5483 Compare July 9, 2026 21:55
@ounsworth ounsworth force-pushed the feature/mikeo/missing_docs_and_nightly_compiler branch from ca9c292 to 3356016 Compare July 10, 2026 14:08
@ounsworth ounsworth force-pushed the feature/mikeo/missing_docs_and_nightly_compiler branch from 3356016 to 4624785 Compare July 10, 2026 14:09
…sing_docs]). Also a small refactor to remove the redundant DUMMY_SEED_512 from core-test-framework.
Comment thread crypto/base64/src/lib.rs
// URLSafe,

#![forbid(unsafe_code)]
#![forbid(missing_docs)]

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you want to maintain your sanity at a reasonable level, try this

root/Cargo.toml

[workspace.lints]
rust.missing_docs = "warn"

and each crate will have in Cargo.toml

[lints]
workspace = true

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll give that a try. Thanks.

@ounsworth ounsworth changed the title Feature/mikeo/missing docs and nightly compiler forbid(missing_docs) and nightly compiler Jul 10, 2026
@ounsworth

Copy link
Copy Markdown
Contributor Author

@officialfrancismendoza I had to comment out his test at keccak.rs:545 because it's failing and I can't figure out what it's supposed to be testing, so I'll need you to debug it.

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