Skip to content

Fix rustdoc warnings #1511

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
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

CGMossa
Copy link
Contributor

@CGMossa CGMossa commented Apr 18, 2025

Ran cargo doc --workspace --no-deps --document-private-items using

❯ rustdoc --version
rustdoc 1.86.0 (05f9846f8 2025-03-31)

Plus, I applied suggestions from markdownlint.

Additions due to CI

I had to update the rustc version in CI from 1.79 to 1.81 due to a dev-dependency.

❯ cargo tree -i half                       
half v2.6.0
└── ciborium-ll v0.2.2
    └── ciborium v0.2.2
        └── criterion v0.4.0
            [dev-dependencies]
            └── nalgebra v0.33.2 (/Users/elea/Documents/GitHub/nalgebra)
                [dev-dependencies]
                └── nalgebra v0.33.2 (/Users/elea/Documents/GitHub/nalgebra) (*)

Also, now the snapshots must be upgraded using TRYBUILD=overwrite cargo +1.81 ..., as there are serious differences in how latest stable behaves vs. 1.81.

CGMossa added 4 commits April 18, 2025 15:49
```
error: rustc 1.79.0 is not supported by the following package:
  [email protected] requires rustc 1.81
```

updated snapshot test
ci: snapshot test again, by

```shell
TRYBUILD=overwrite cargo +1.81 test stack
```
@CGMossa CGMossa force-pushed the fix_rustdoc_warnings branch from c526702 to 8fe72fc Compare April 19, 2025 18:00
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.

1 participant