ENH: Specify public objects for doctesting

scipy / scipy_doctest

Floating-point aware doctesting

BSD 3-Clause "New" or "Revised" License

5 stars 4 forks source link

ENH: Specify public objects for doctesting #100

Closed Sheila-nk closed 11 months ago

Sheila-nk commented 12 months ago

if strategy=api, only public objects specified in an __all__ attribute within the module should be collected for doctesting.

Closes #98

Sheila-nk commented 12 months ago

@ev-br Maybe at some point strategy could be made user-configurable?

ev-br commented 12 months ago

Maybe at some point strategy could be made user-configurable?

Most certainly. It is configurable in the scpdt layer, should propagate the switch to the plugin layer.

ev-br commented 12 months ago

Can you double-check that it works for scipy without the plugin? Compare the logs, check that items are not missing.

Sheila-nk commented 11 months ago

@ev-br I have confirmed now that no test items are missed. I will push the doctest log to the scipy PR after ignoring the test items from numpy.

Sheila-nk commented 11 months ago

Using the skiplist works, but comes up short when there are duplicate items: #102 The current solution is to include the duplicates in the skiplist but I have opened an issue to follow up and make the collection more seamless.

Sheila-nk commented 11 months ago

No, I think this PR is good to go. I will merge it now.