search

transientskp / pyse

Python Source Extractor
BSD 2-Clause "Simplified" License
11 stars 5 forks source link

Add developer documentation #59

Closed suvayu closed 1 month ago

suvayu commented 1 month ago
suvayu commented 1 month ago

@HannoSpreeuw could you check the README, do you think it's missing something. I was in the flow, and forgot to create a PR :stuck_out_tongue:

HannoSpreeuw commented 1 month ago

Looks great. Nice and complete.

while development ---> while developing?

if you want to trigger only the build hooks..... "build hooks" have a high abstraction level for me. Perhaps a few extra words about what they are?

The hatch run test:pytest --no-cov may be relevant for PyCharm users, since you cannot debug tests from pytest in PyCharm if you have coverage enabled. But adding that to this README may not be appropriate.

suvayu commented 1 month ago

But adding that to this README may not be appropriate.

This readme update is until I get around to #60. It would fit nicely in an extended developer docs.