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

Document types in {mullvad,talpid}-types #1698

Merged
merged 1 commit into from
May 4, 2020
Merged

Document types in {mullvad,talpid}-types #1698

merged 1 commit into from
May 4, 2020

Conversation

dlon
Copy link
Member

@dlon dlon commented Apr 30, 2020

Adds documentation to most of the remaining types in these crates. The comments should ideally explain what they're for, where they're being used, and why.


This change is Reviewable

Copy link
Collaborator

@pinkisemils pinkisemils left a comment

Choose a reason for hiding this comment

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

Reviewed 4 of 11 files at r1.
Reviewable status: 4 of 11 files reviewed, 1 unresolved discussion (waiting on @dlon)


mullvad-types/src/auth_failed.rs, line 5 at r1 (raw file):

use std::fmt;

/// Used in the CLI to represent a failure by the tunnel to authenticate with a remote server.

This is also used in the GUI when displaying the authentication failure reason. This is originally received from the OpenVPN server and then our plugin sends it over to the daemon.

Copy link
Collaborator

@pinkisemils pinkisemils 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 6 of 11 files at r1, 4 of 4 files at r2.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @dlon)

Copy link
Member Author

@dlon dlon 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: 10 of 11 files reviewed, 1 unresolved discussion (waiting on @pinkisemils)


mullvad-types/src/auth_failed.rs, line 5 at r1 (raw file):

Previously, pinkisemils (Emīls Piņķis) wrote…

This is also used in the GUI when displaying the authentication failure reason. This is originally received from the OpenVPN server and then our plugin sends it over to the daemon.

Done.

Copy link
Collaborator

@pinkisemils pinkisemils left a comment

Choose a reason for hiding this comment

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

Reviewed 1 of 1 files at r3.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved

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