Skip to content

[FEATURE] improve API documentation #243

Open
@mgovers

Description

@mgovers

Describe the feature request

The API exposes some functionality in modules via the __init__.py. E.g. a user may call to power_grid_model_io.functions.has_value.

However, the documentation refers to several API functions by their private module, e.g. power_grid_model_io.functions._functions.has_value(value: Any) → bool

This feature is about updating the documentation so that it refers to the public module that exposes the function, rather than the private module in which it is defined.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueIndicates a good issue for first-time contributors

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions