Skip to content

Improve docs for KDE #318

@OriolAbril

Description

@OriolAbril

The docs for kde should mention where **kwargs of each function are forwarded to, and each of these functions where we forward things too should also appear in the docs (or alternatively, the whole of available kwargs hosuld be described in the first function without linking anywhere).

arviz_stats.kde mentions dataarray and array interfaces without linking: https://python.arviz.org/projects/stats/en/latest/api/generated/arviz_stats.kde.html#arviz_stats.kde.

arviz_stats.base.dataarray_stats.kde has no docstring at all so it need defining where kwargs go and add those functions also to dataarray_stats docs. (or say the description is in the array_stats docs and link there).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions