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.

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

Merged
merged 1 commit into from
Apr 22, 2024
Merged

Fix broken links in rustdocs #6160

merged 1 commit into from
Apr 22, 2024

Conversation

Serock3
Copy link
Contributor

@Serock3 Serock3 commented Apr 19, 2024

I ran cargo doc and fixed as many broken links as I could find.

Fixes DES-899.


This change is Reviewable

Copy link

linear bot commented Apr 22, 2024

Copy link
Contributor

@MarkusPettersson98 MarkusPettersson98 left a 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`.

@Serock3 Serock3 force-pushed the fix-broken-doclinks branch from 52b8728 to a19d964 Compare April 22, 2024 10:08
Copy link
Contributor Author

@Serock3 Serock3 left a 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.

Copy link
Contributor

@MarkusPettersson98 MarkusPettersson98 left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewed 2 of 2 files at r2, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved

I ran `cargo doc` and fixed as many broken links as I could find.
@MarkusPettersson98 MarkusPettersson98 merged commit 88145b7 into main Apr 22, 2024
38 of 41 checks passed
@MarkusPettersson98 MarkusPettersson98 deleted the fix-broken-doclinks branch April 22, 2024 11:10
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.

2 participants