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

docs: tidy documentation in the scion_proto crate. #129

Merged
merged 1 commit into from
Jan 26, 2024

Conversation

jpcsmith
Copy link
Contributor

@jpcsmith jpcsmith commented Jan 25, 2024

Contributes to #123

Copy link
Contributor

github-actions bot commented Jan 25, 2024

Code Coverage

Package Line Rate Health
crates/scion-proto/src/packet 80%
crates/scion-proto/src/address 70%
crates/scion-proto/src/reliable 95%
crates/scion/src/pan/path_strategy 83%
crates/scion/src 80%
crates/scion-proto/src/path 83%
crates/scion/src/daemon 91%
crates/scion/src/socket 77%
crates/scion/src/pan 78%
crates/scion-proto/src/scmp 77%
crates/scion-proto/src/packet/headers 85%
crates/scion-proto/src/path/metadata 100%
crates/scion-proto/src/path/standard 92%
crates/scion-proto/src 79%
Summary 79% (1930 / 2429)

@mlegner mlegner mentioned this pull request Jan 26, 2024
8 tasks
Copy link
Contributor

@mlegner mlegner left a comment

Choose a reason for hiding this comment

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

Thanks a lot for taking care of this, this will be very helpful to users of the library.

For now, just two questions from my side.

crates/scion-proto/src/address/isd.rs Show resolved Hide resolved
crates/scion-proto/src/address/asn.rs Show resolved Hide resolved
@jpcsmith jpcsmith force-pushed the feat/documentation branch 2 times, most recently from 9f11114 to cbddf85 Compare January 26, 2024 15:40
@jpcsmith jpcsmith marked this pull request as ready for review January 26, 2024 15:40
@jpcsmith jpcsmith requested a review from mlegner January 26, 2024 15:41
@jpcsmith jpcsmith self-assigned this Jan 26, 2024
crates/scion-proto/src/lib.rs Outdated Show resolved Hide resolved
@mlegner mlegner changed the title doc: tidy documentation in the scion_proto crate. docs: tidy documentation in the scion_proto crate. Jan 26, 2024
@jpcsmith jpcsmith enabled auto-merge (rebase) January 26, 2024 15:50
@jpcsmith jpcsmith merged commit 62cfa68 into main Jan 26, 2024
11 checks passed
@jpcsmith jpcsmith deleted the feat/documentation branch January 26, 2024 15:53
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