Skip to content
This repository has been archived by the owner on Aug 31, 2023. It is now read-only.

chore: fix broken rust documentation #2805

Merged
merged 2 commits into from
Jul 1, 2022
Merged

chore: fix broken rust documentation #2805

merged 2 commits into from
Jul 1, 2022

Conversation

ematipico
Copy link
Contributor

Summary

This PR fixes all the warnings emitted by the command cargo doc inside the crate rome_formatter

Test Plan

No warnings when cargo doc is run

@ematipico ematipico temporarily deployed to aws July 1, 2022 11:19 Inactive
@ematipico ematipico requested a review from a team July 1, 2022 11:19
@cloudflare-pages
Copy link

cloudflare-pages bot commented Jul 1, 2022

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: d1e647e
Status: ✅  Deploy successful!
Preview URL: https://383639ef.tools-8rn.pages.dev
Branch Preview URL: https://chore-fix-broken-doc.tools-8rn.pages.dev

View logs

@github-actions
Copy link

github-actions bot commented Jul 1, 2022

Parser conformance results on ubuntu-latest

js/262

Test result main count This PR count Difference
Total 45878 45878 0
Passed 44938 44938 0
Failed 940 940 0
Panics 0 0 0
Coverage 97.95% 97.95% 0.00%

jsx/babel

Test result main count This PR count Difference
Total 39 39 0
Passed 36 36 0
Failed 3 3 0
Panics 0 0 0
Coverage 92.31% 92.31% 0.00%

symbols/microsoft

Test result main count This PR count Difference
Total 5946 5946 0
Passed 388 388 0
Failed 5558 5558 0
Panics 0 0 0
Coverage 6.53% 6.53% 0.00%

ts/babel

Test result main count This PR count Difference
Total 588 588 0
Passed 519 519 0
Failed 69 69 0
Panics 0 0 0
Coverage 88.27% 88.27% 0.00%

ts/microsoft

Test result main count This PR count Difference
Total 16257 16257 0
Passed 12393 12393 0
Failed 3864 3864 0
Panics 0 0 0
Coverage 76.23% 76.23% 0.00%

@github-actions
Copy link

github-actions bot commented Jul 1, 2022

Copy link
Contributor

@leops leops left a comment

Choose a reason for hiding this comment

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

We probably should add #![deny(rustdoc::broken_intra_doc_links)] to the root of all the crates, and run cargo doc at least in the check workflows to ensure we don't re-introduce this kind of issues in the future

crates/rome_formatter/src/lib.rs Outdated Show resolved Hide resolved
crates/rome_rowan/src/cursor/trivia.rs Outdated Show resolved Hide resolved
@ematipico ematipico temporarily deployed to aws July 1, 2022 12:28 Inactive
@ematipico
Copy link
Contributor Author

We probably should add #![deny(rustdoc::broken_intra_doc_links)] to the root of all the crates, and run cargo doc at least in the check workflows to ensure we don't re-introduce this kind of issues in the future

I plan to add the workflow in the next iteration. I will crate another PR

@ematipico ematipico requested a review from leops July 1, 2022 12:29
@ematipico ematipico merged commit 69cb3ea into main Jul 1, 2022
@ematipico ematipico deleted the chore/fix-broken-doc branch July 1, 2022 13:09
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants