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 rustdoc warnings #793

Merged
merged 9 commits into from
Sep 5, 2023
Merged

Fix all rustdoc warnings #793

merged 9 commits into from
Sep 5, 2023

Conversation

neysofu
Copy link
Member

@neysofu neysofu commented Sep 4, 2023

Description

Fix broken links in documentations and any other warning generated by rustdoc.

@neysofu
Deny warnings for cargo doc
8a974fb 
Signed-off-by: Filippo Costa <filippo@sovlabs.io>
@neysofu neysofu added the documentation Improvements or additions to documentation label Sep 4, 2023
@codecov
Copy link

codecov bot commented Sep 4, 2023

Codecov Report

Merging #793 (5dab36c) into nightly (f8d3270) will decrease coverage by 0.1%.
The diff coverage is n/a.

Files Changed Coverage Δ
adapters/celestia/src/celestia.rs 59.8% <ø> (ø)
adapters/celestia/src/verifier/address.rs 95.0% <ø> (ø)
full-node/db/sov-db/src/schema/tables.rs 85.0% <ø> (ø)
full-node/db/sov-schema-db/src/lib.rs 90.7% <ø> (ø)
...tions/integration-tests/src/chain_state/helpers.rs 100.0% <ø> (ø)
...implementations/sov-attester-incentives/src/lib.rs 23.6% <ø> (ø)
...system/module-implementations/sov-bank/src/call.rs 89.6% <ø> (ø)
...ystem/module-implementations/sov-bank/src/token.rs 80.9% <ø> (ø)
...dule-implementations/sov-blob-storage/src/query.rs 14.2% <ø> (ø)
.../module-implementations/sov-chain-state/src/lib.rs 90.5% <ø> (ø)
... and 11 more

... and 2 files with indirect coverage changes

@neysofu neysofu marked this pull request as ready for review September 4, 2023 17:57
@neysofu neysofu enabled auto-merge September 4, 2023 17:57
@neysofu neysofu added this pull request to the merge queue Sep 5, 2023
Merged via the queue into nightly with commit a82743d Sep 5, 2023
@neysofu neysofu deleted the filippo/fix-docs branch September 5, 2023 01:40
preston-evans98 pushed a commit that referenced this pull request Sep 14, 2023
@neysofu @preston-evans98
Fix all rustdoc warnings (#793)
83764fb 
* Deny warnings for cargo doc

Signed-off-by: Filippo Costa <filippo@sovlabs.io>

* Separate cache for cargo doc

* WIP fixes

* Fix all warnings

* Use language tag TOML in readme

* Fix table of contents

Signed-off-by: Filippo Costa <filippo@sovlabs.io>

* Add explanatory comment

Signed-off-by: Filippo Costa <filippo@sovlabs.io>

* Add dev-dep for doctest

* Fix trailing space

---------

Signed-off-by: Filippo Costa <filippo@sovlabs.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@preston-evans98 preston-evans98 preston-evans98 approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@neysofu @preston-evans98