SETI / rms-pds4indextools

PDS4 index tools Python module
Apache License 2.0
0 stars 0 forks source link

Fixing documentation, adding explanatory comments to unit tests #30

Closed esimpsons3ti closed 1 month ago

esimpsons3ti commented 1 month ago

The documentation previously stated that an understanding of XPath was necessary to use the tool effectively. This has been replaced with a passage that instead demonstrates how to read and understand the XPath-based headers the tool creates.

The blackbox unit tests have been given explanatory block comments for each entry. Each block comment contains the equivalent command-line query and the golden copy file to compare the results against.

Fixes #19

codecov[bot] commented 1 month ago

Codecov Report

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

Project coverage is 71.20%. Comparing base (6f7e07c) to head (99acafa).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #30 +/- ## ======================================= Coverage 71.20% 71.20% ======================================= Files 1 1 Lines 587 587 Branches 134 134 ======================================= Hits 418 418 Misses 144 144 Partials 25 25 ```

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