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

Refactor packages: write docs #1337

Merged

Conversation

josecelano
Copy link
Member

Refactor packages: write docs

Added documentation for pacakges.

@josecelano josecelano self-assigned this Mar 3, 2025
@josecelano josecelano added Documentation Improves Instructions, Guides, and Notices - Developer - Torrust Improvement Experience labels Mar 3, 2025
@josecelano josecelano requested a review from da2ce7 March 3, 2025 09:27
@josecelano josecelano linked an issue Mar 3, 2025 that may be closed by this pull request
2 tasks
@josecelano josecelano force-pushed the 1290-refactor-packages-write-docs branch from 4ee9def to a8224e8 Compare March 3, 2025 09:32
Copy link

codecov bot commented Mar 3, 2025

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 81.52%. Comparing base (77c8395) to head (b76eff6).
Report is 3 commits behind head on develop.

Files with missing lines Patch % Lines
src/console/ci/e2e/runner.rs 0.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1337      +/-   ##
===========================================
+ Coverage    81.51%   81.52%   +0.01%     
===========================================
  Files          230      230              
  Lines        16275    16275              
  Branches     16275    16275              
===========================================
+ Hits         13266    13268       +2     
+ Misses        2776     2770       -6     
- Partials       233      237       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

```output
error: unnecessary `Debug` formatting in `format!` args
   --> src/console/ci/e2e/runner.rs:140:98
    |
140 |     let config = std::fs::read_to_string(path).with_context(|| format!("CSan't read config file {path:?}"))?;
    |                                                                                                  ^^^^
    |
    = help: use `Display` formatting and change this to `path.display()`
    = note: switching to `Display` formatting will change how the value is shown; escaped characters will no longer be escaped and surrounding quotes will be removed
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#unnecessary_debug_formatting
    = note: `-D clippy::unnecessary-debug-formatting` implied by `-D clippy::pedantic`
    = help: to override `-D clippy::pedantic` add `#[allow(clippy::unnecessary_debug_formatting)]`

error: could not compile `torrust-tracker` (lib) due to 1 previous error
warning: build failed, waiting for other jobs to finish...
error: could not compile `torrust-tracker` (lib test) due to 1 previous error
```
@josecelano
Copy link
Member Author

ACK b76eff6

@josecelano josecelano merged commit d918e47 into torrust:develop Mar 3, 2025
22 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
- Developer - Torrust Improvement Experience Documentation Improves Instructions, Guides, and Notices
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor packages: write docs
1 participant