Some unecessary exported names about complexitymeasures.jl HOT 5 CLOSED

That's a lot of names, and some are internal functions. They might be expanded in the docs, but you can preface the expansion with Entropies.name and the docstring can be expanded nevertheless.

Good point. Internal functions don't need to be exported. I'll do a PR on it.

Of course, please correct me if some of these names are important for normal usage of CausalityTools and co.

For the names that are important for CausalityTools, I will simply import and export them in CausalityTools too if necessary. No need to expose the user to internals unnecessarily.

from complexitymeasures.jl.

I don't think duplication is bad here. I already have several cases where I use Entropies.jl alone, so then it would be cumbersome to go somewhere else to look for the documentation.

I see that many packages list unexported names in a separate page in their documentation. We could have a "Unexported (for pkg devs)" menu item that lists useful stuff that a regular don't necessarily need to use.

from complexitymeasures.jl.

@Datseris If the names are not to be exported, maybe we should remove them from the documentation too? We, the package maintainers, that potentially use the internals in other packages too, know what to look for.

I think the docs are much cleaner if the only thing that appears on each estimator doc page is the info about that estimator. What do you think?

from complexitymeasures.jl.

Sure, as I said, I maintain docs of Entropy.jl in the central documentation of DynamicalSystems.jl and there I don't have these docstrings.

Perhaps you want to consider that we have the docs only there, and we stop hosting and improving docs here as well?

from complexitymeasures.jl.

Closed with #41

from complexitymeasures.jl.