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.

Sign up for GitHub

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

Jump to bottom

Fix all check-rust-docs warnings #1399

Closed
t4lz opened this issue May 10, 2023 · 1 comment · Fixed by #2436
Closed

Fix all check-rust-docs warnings #1399

t4lz opened this issue May 10, 2023 · 1 comment · Fixed by #2436
Assignees
@gememma
Labels
documentation Improvements or additions to documentation easy good first issue Good for newcomers

Comments

@t4lz
Copy link
Member

t4lz commented May 10, 2023 •
edited by Anita-ihuman

Existing warnings are shown in the "Unchanged files with check annotations" parts of PRs' code, e.g. https://github.com/metalbear-co/mirrord/pull/1343/files#file-mirrord-protocol-src-outgoing-rs-L102.

We should fix all of those issues so that there are no preexisting warnings, then not merge new warning-inducing code into main.

Where to begin?

Please refer to the CONTRIBUTING.md file
@t4lz t4lz added documentation Improvements or additions to documentation good first issue Good for newcomers easy labels May 10, 2023
@Razz4780 Razz4780 assigned Razz4780 and gememma and unassigned Razz4780 May 8, 2024
@gememma
Copy link
Contributor

gememma commented May 9, 2024

Running cargo doc --document-private-items --no-deps generates around 70 warnings, so this might take longer than initially expected. It looks like most of the warnings are broken links.

@gememma gememma mentioned this issue May 10, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gememma gememma

Labels
documentation Improvements or additions to documentation easy good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix check-rust-docs warnings gememma/mirrord
3 participants
@t4lz @Razz4780 @gememma