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

Result doc comments #605

Merged
merged 2 commits into from
Jul 19, 2023
Merged

Result doc comments #605

merged 2 commits into from
Jul 19, 2023

Conversation

zslayton
Copy link
Contributor

Adds doc comments to:

  • The decimal module
  • The decimal::coefficient module
  • The result module and its nested error types

Fixes #587.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@codecov
Copy link

codecov bot commented Jul 19, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (d35d6ae) 82.39% compared to head (49ca3e4) 82.39%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #605   +/-   ##
=======================================
  Coverage   82.39%   82.39%           
=======================================
  Files         111      111           
  Lines       20048    20048           
  Branches    20048    20048           
=======================================
  Hits        16518    16518           
  Misses       1912     1912           
  Partials     1618     1618           
Impacted Files Coverage Δ
src/result/decoding_error.rs 83.33% <ø> (ø)
src/result/encoding_error.rs 83.33% <ø> (ø)
src/result/illegal_operation.rs 88.88% <ø> (ø)
src/result/incomplete.rs 90.00% <ø> (ø)
src/result/io_error.rs 0.00% <ø> (ø)
src/result/mod.rs 64.86% <ø> (ø)
src/types/decimal/coefficient.rs 89.09% <ø> (ø)
src/types/decimal/mod.rs 91.09% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@zslayton zslayton merged commit 4efce02 into main Jul 19, 2023
18 checks passed
@zslayton zslayton deleted the result-doc-comments branch July 19, 2023 17:17
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.

Add documentation for public types and modules
3 participants