don’t doctest in extern by default

astropy / package-template

Template for packages that use Astropy. Maintainer: @astrofrog

http://docs.astropy.org/projects/package-template/en/latest/

Other

60 stars 63 forks source link

don’t doctest in extern by default #494

Closed nstarman closed 11 months ago

nstarman commented 3 years ago

It's not meant to be safe by default. If it is, then this can be removed by the package author.

fixes: #486

Signed-off-by: Nathaniel Starkman nstarkman@protonmail.com

nstarman commented 3 years ago

@astrofrog wrt #121, what do you think?

bsipocz commented 3 years ago

Would be nice to add some testing for all these new things, but I'm not sure how to do that nicely without littering the user rendered template. Maybe a non working code example in the __init__.py is enough to say it's not tested by default? (I'm not sure that file would be normally picked up for testing anyway)

nstarman commented 3 years ago

@bsipocz, I added an example to __init__.py

I'm noticing that astropy has a different setup for not recursing directories. Is this a preferable design philosophy?

norecursedirs =
    ...
    "astropy[\/]extern"

nstarman commented 3 years ago

ping @bsipocz. Otherwise this PR is ready for review.

pllim commented 11 months ago

See https://github.com/astropy/package-template#deprecation-warning