search

Chilipp / docrep

A Python Module for intelligent reuse of docstrings
Apache License 2.0
30 stars 4 forks source link

Fix part of the docstrings doctests #7

Closed lesteve closed 6 years ago

lesteve commented 6 years ago

It started by wanting to remove the psyplot.docstring occurences but while I was at it I quickly looked at the doctests and fixed the easy one.

I had a quick look, and FYI you still have failures in your doctests. To reproduce:

pytest docrep --doctest-modules

I am not sure some of the stuff you are doing is easy to test with doctest (e.g. multi-line expected outputs with blank lines in the middle or expected exceptions) so maybe # doctest: +SKIP is the right approach and/or moving some of your doctest code to tests.

coveralls commented 6 years ago

Coverage Status

Coverage remained the same at 96.216% when pulling a24ce351c7f75263a0cf00899c16514731998a2c on lesteve:fix-some-doctests into 5ab53390bac150ea4b59103662938dd5cc9f1b98 on Chilipp:master.

coveralls commented 6 years ago

Coverage Status

Coverage remained the same at 96.216% when pulling a24ce351c7f75263a0cf00899c16514731998a2c on lesteve:fix-some-doctests into 5ab53390bac150ea4b59103662938dd5cc9f1b98 on Chilipp:master.

coveralls commented 6 years ago

Coverage Status

Coverage remained the same at 96.216% when pulling a24ce351c7f75263a0cf00899c16514731998a2c on lesteve:fix-some-doctests into 5ab53390bac150ea4b59103662938dd5cc9f1b98 on Chilipp:master.

Chilipp commented 6 years ago

Thanks @lesteve ! Those are good points. I fix this and implement the doctest in the CI config

lesteve commented 6 years ago

Great to hear that!