frequenz-floss / frequenz-sdk-python

Frequenz Python Software Development Kit (SDK)
https://frequenz-floss.github.io/frequenz-sdk-python/
MIT License
13 stars 17 forks source link

[Documentation] `ComponentMetricId` is not documented #985

Open matthias-wende-frequenz opened 1 week ago

matthias-wende-frequenz commented 1 week ago

What happened?

The ComponentMetricId is used as a type for parameters in several places in the Documentation but the Type itself is not documented, which makes it hard to determine what to pass.

What did you expect instead?

Link to the documentation or definition.

Affected version(s)

No response

Affected part(s)

Documentation (part:docs)

Extra information

This is the link to the definition. https://github.com/frequenz-floss/frequenz-client-microgrid-python/blob/v0.x.x/src/frequenz/client/microgrid/_component.py#L192

llucax commented 1 week ago

So the class is documented, it is just not publicly exposed, right? So this issue is only about re-exporting it in https://github.com/frequenz-floss/frequenz-client-microgrid-python/blob/v0.x.x/src/frequenz/client/microgrid/__init__.py, right? Or do you think the class documentation needs to be improved too?

matthias-wende-frequenz commented 1 week ago

It's about exposing it publicly.

llucax commented 1 week ago

Easy fix then.