Skip to content
This repository has been archived by the owner on Oct 30, 2023. It is now read-only.

create rfc for @educational decorator #2

Closed
gregcaporaso opened this issue Aug 17, 2015 · 3 comments
Closed

create rfc for @educational decorator #2

gregcaporaso opened this issue Aug 17, 2015 · 3 comments

Comments

@gregcaporaso
Copy link
Contributor

We'd want this to:

  • point to a production version (and add See Also)
  • inject standard warning about using efficiency of educational code version production code
  • inherit docstring from production version
  • confirm signature is the same between the educational and production implementations
@wasade
Copy link
Member

wasade commented Aug 21, 2015

I think a critical item here is how the test code is handled as I think it would be useful to exercise the API independent of the implementation. The indirection done with scikit-bio/scikit-bio#1040 probably isn't the best way to go about it, but it works for the moment. Specifically, I think we may want to do a single mixin base per method tested as opposed to having combined code (as is the case with unweighted_unifrac and weighted_unifrac). I suspect there is a common approach that can be taken with the test code which I believe would help to standardize the inclusion of different implementations of methods.

@gregcaporaso
Copy link
Contributor Author

I agree that this is a key piece, and I agree that separating the tests out per method is a better way to go than what I did for the *unifrac tests.

@gregcaporaso
Copy link
Contributor Author

We've decided that educational implementations are better suited for IAB, which will also simplify scikit-bio. This will be revisited in the context of IAB (gregcaporaso/An-Introduction-to-Applied-Bioinformatics#180).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants