Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] improve API documentation #243

Open
mgovers opened this issue Apr 11, 2024 · 0 comments
Open

[FEATURE] improve API documentation #243

mgovers opened this issue Apr 11, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Indicates a good issue for first-time contributors

Comments

@mgovers
Copy link
Member

mgovers commented Apr 11, 2024

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.

@mgovers mgovers added the documentation Improvements or additions to documentation label Apr 11, 2024
@mgovers mgovers added the good first issue Indicates a good issue for first-time contributors label Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Indicates a good issue for first-time contributors
Projects
Status: No status
Development

No branches or pull requests

1 participant