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!: create docs and readme. #217

Merged
merged 6 commits into from
Mar 26, 2024
Merged

docs!: create docs and readme. #217

merged 6 commits into from
Mar 26, 2024

Conversation

gusinacio
Copy link
Collaborator

@gusinacio gusinacio commented Mar 25, 2024

update the modules for better visibility and documentation

Fixes TAP-182

This comment has been minimized.

update the modules for better visibility and documentation

Signed-off-by: Gustavo Inacio <gustavo@semiotic.ai>
Signed-off-by: Gustavo Inacio <gustavo@semiotic.ai>
Signed-off-by: Gustavo Inacio <gustavo@semiotic.ai>

This comment has been minimized.

1 similar comment

This comment has been minimized.

Copy link

github-actions bot commented Mar 25, 2024

Pull Request Test Coverage Report for Build 8424328851

Details

  • 9 of 12 (75.0%) changed or added relevant lines in 5 files are covered.
  • 2 unchanged lines in 2 files lost coverage.
  • Overall coverage decreased (-0.5%) to 78.809%

Changes Missing Coverage Covered Lines Changed/Added Lines %
tap_core/src/receipt/state.rs 1 4 25.0%
Files with Coverage Reduction New Missed Lines %
tap_core/src/receipt/checks.rs 1 76.81%
tap_core/src/rav/request.rs 1 0.0%
Totals Coverage Status
Change from base Build 8269039047: -0.5%
Covered Lines: 900
Relevant Lines: 1142

💛 - Coveralls

Copy link
Collaborator

@aasseman aasseman left a comment

Choose a reason for hiding this comment

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

Beautiful!

  • Just a few suggestions here and there
  • Could you also make sure all comments/docstrings lines are under 100 chars long? If you have more it tends to completely (and silently) break rustfmt on those files.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
tap_core/src/rav.rs Outdated Show resolved Hide resolved
tap_core/src/rav.rs Outdated Show resolved Hide resolved
tap_core/src/rav.rs Outdated Show resolved Hide resolved
tap_core/src/signed_message.rs Outdated Show resolved Hide resolved
tap_core/src/signed_message.rs Outdated Show resolved Hide resolved
Signed-off-by: Gustavo Inacio <gustavo@semiotic.ai>

This comment has been minimized.

1 similar comment

This comment has been minimized.

Signed-off-by: Gustavo Inacio <gustavo@semiotic.ai>

This comment has been minimized.

Copy link
Collaborator

@aasseman aasseman left a comment

Choose a reason for hiding this comment

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

I got a couple more sorry 😬

tap_core/src/signed_message.rs Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Signed-off-by: Gustavo Inacio <gustavo@semiotic.ai>
@gusinacio gusinacio requested a review from aasseman March 26, 2024 13:36
Copy link

🤖 Cargo Audit Report 🤖

(Empty means OK! 👍)

@gusinacio gusinacio merged commit 1a1edf0 into main Mar 26, 2024
10 checks passed
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.

None yet

2 participants