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 web module #1041

Merged
merged 6 commits into from
May 22, 2023
Merged

Document web module #1041

merged 6 commits into from
May 22, 2023

Conversation

Luni-4
Copy link
Collaborator

@Luni-4 Luni-4 commented Apr 21, 2023

This PR fixes #383.

Unfortunately doc tests on binary cannot still be executed because of rust-lang/rust#50784 (comment), but we can create them the same waiting for the feature to be implemented

Otherwise we can transform this module in a lib, with a binary associated, in this way we can document all APIs and at the same time having an executable

@Luni-4 Luni-4 marked this pull request as draft April 21, 2023 09:55
@codecov-commenter
Copy link

codecov-commenter commented Apr 21, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (726de3d) 74.18% compared to head (4260831) 74.19%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1041   +/-   ##
=======================================
  Coverage   74.18%   74.19%           
=======================================
  Files          64       65    +1     
  Lines       15915    15916    +1     
=======================================
+ Hits        11807    11809    +2     
+ Misses       4108     4107    -1     
Impacted Files Coverage Δ
...ode-analysis-web/src/bin/rust-code-analysis-web.rs 8.33% <ø> (ø)
rust-code-analysis-web/src/web/comment.rs 100.00% <ø> (ø)
rust-code-analysis-web/src/web/function.rs 100.00% <ø> (ø)
rust-code-analysis-web/src/web/metrics.rs 94.44% <ø> (ø)
rust-code-analysis-web/src/web/server.rs 69.03% <ø> (ø)
rust-code-analysis-web/src/lib.rs 100.00% <100.00%> (ø)

... and 1 file with indirect coverage changes

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

@Luni-4 Luni-4 marked this pull request as ready for review May 19, 2023 17:40
@Luni-4
Copy link
Collaborator Author

Luni-4 commented May 19, 2023

I finished documenting the web module, converted it in a library in order to add more tests and doc-tests, and also improved the server test

@Luni-4 Luni-4 requested a review from marco-c May 19, 2023 17:41
@marco-c marco-c merged commit d29ce77 into master May 22, 2023
@marco-c marco-c deleted the document-web branch May 22, 2023 16:03
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.

Document web module
3 participants