search

justindujardin / pathy

simple, flexible, offline capable, cloud storage with a Python path-like interface
Apache License 2.0
171 stars 23 forks source link

Feature/test doc snippets #40

Closed justindujardin closed 3 years ago

justindujardin commented 3 years ago

There's nothing worse than a readme example snippet that runs and errors. This adds a script that extracts the runnable code-blocks from README.md and executes them. If one errors, the build will fail. The script is run during the CI build.

codecov[bot] commented 3 years ago

Codecov Report

Merging #40 (cbde5b8) into master (e322083) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #40   +/-   ##
=======================================
  Coverage   89.09%   89.09%           
=======================================
  Files           7        7           
  Lines         899      899           
=======================================
  Hits          801      801           
  Misses         98       98

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update e322083...cbde5b8. Read the comment docs.

justindujardin commented 3 years ago

:tada: This PR is included in version 0.3.5 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: