coady / multimethod

Multiple argument dispatching.
https://coady.github.io/multimethod
Other
277 stars 24 forks source link

Combine docstrings #9

Closed bagibence closed 4 years ago

bagibence commented 4 years ago

I copied the approach from the multipledispatch library and quickly threw together an example of how the docstrings from the registered functions of a multimethod could be combined.

I'm not sure if this is the right approach here or if it messes up anything else, just thought it might be useful.

Fixes #8

coady commented 4 years ago

The build failure is because f-strings were added in 3.6. Maybe it's time to drop 3.5 support anyway; many projects have already.

bagibence commented 4 years ago

Or do you want me to rewrite it and use another way of formatting?

coady commented 4 years ago

I'm not sure separating the doc/no-doc into 2 groups is necessary vs just leaving an empty string, so I might make that edit. Thanks for the contribution!

vnmabus commented 2 years ago

This is a little bit (very) ugly: https://fda.readthedocs.io/en/latest/modules/autosummary/skfda.misc.inner_product.html#skfda.misc.inner_product

Can it be made opt-in at least?

coady commented 2 years ago

This is a little bit (very) ugly: https://fda.readthedocs.io/en/latest/modules/autosummary/skfda.misc.inner_product.html#skfda.misc.inner_product

Can it be made opt-in at least?

Looks like in that example only in the first function has a docstring. Would it work for your use case to ignore functions without a docstring?

vnmabus commented 2 years ago

I think so, yes.

vnmabus commented 2 years ago

When will this change be released?

coady commented 2 years ago

When will this change be released?

Released v1.7.

vnmabus commented 2 years ago

Thank you!