-
Notifications
You must be signed in to change notification settings - Fork 390
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
Fix broken links in rustdocs #6160
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed 21 of 21 files at r1, all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @Serock3)
mullvad-management-interface/src/client.rs
line 613 at r1 (raw file):
/// - `access_method`: If `Some(access_method)`, `AccessModeSelector` will skip ahead and return /// `access_method` when asked for a new access method. If `None`, `AccessModeSelector` will /// pick the next access method "randomly"
Nit: This part of the comment feels very weird :s Feel free to remove it
Code quote:
///
/// - `access_method`: If `Some(access_method)`, `AccessModeSelector` will skip ahead and return
/// `access_method` when asked for a new access method. If `None`, `AccessModeSelector` will
/// pick the next access method "randomly"
talpid-types/src/net/proxy.rs
line 237 at r1 (raw file):
/// List of ciphers usable by a Shadowsocks proxy. /// Cf. `mullvad_daemon::migrations::v7::cipher`.
I don't think this link is correct anymore. We refer to something that was removed in a migration, and without that source material I think we should remove this part of the comment 😊
Code quote:
/// Cf. `mullvad_daemon::migrations::v7::cipher`.
52b8728
to
a19d964
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewable status: 19 of 21 files reviewed, 1 unresolved discussion (waiting on @MarkusPettersson98)
talpid-types/src/net/proxy.rs
line 237 at r1 (raw file):
Previously, MarkusPettersson98 (Markus Pettersson) wrote…
I don't think this link is correct anymore. We refer to something that was removed in a migration, and without that source material I think we should remove this part of the comment 😊
Done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed 2 of 2 files at r2, all commit messages.
Reviewable status:complete! all files reviewed, all discussions resolved
I ran `cargo doc` and fixed as many broken links as I could find.
a19d964
to
a0f3abe
Compare
I ran
cargo doc
and fixed as many broken links as I could find.Fixes DES-899.
This change is