fox-it / dissect.target

The Dissect module tying all other Dissect modules together. It provides a programming API and command line tools which allow easy access to various data sources inside disk images or file collections (a.k.a. targets).
GNU Affero General Public License v3.0
37 stars 41 forks source link

Format yields in docstring for rst generation #692

Closed Miauwkeru closed 1 month ago

Miauwkeru commented 2 months ago
codecov-commenter commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 75.19%. Comparing base (3bca243) to head (0208fe9).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #692 +/- ## ======================================= Coverage 75.19% 75.19% ======================================= Files 292 292 Lines 24848 24848 ======================================= Hits 18685 18685 Misses 6163 6163 ``` | [Flag](https://app.codecov.io/gh/fox-it/dissect.target/pull/692/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=fox-it) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/fox-it/dissect.target/pull/692/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=fox-it) | `75.19% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=fox-it#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

narimantos commented 2 months ago

the highlighting seems a bit off. See below: image

Maybe try doing it with the code-block? .. code-block:: text