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.

Sign up for GitHub

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

Jump to bottom

Document class and module attributes #618

Merged
merged 6 commits into from
Sep 5, 2023
Merged

Document class and module attributes #618

merged 6 commits into from
Sep 5, 2023

Conversation

daniel-zullo-frequenz
Copy link
Contributor

Add or amend docstrings for all classes and modules where needed.

Fixes #74

@daniel-zullo-frequenz daniel-zullo-frequenz self-assigned this Aug 30, 2023
@github-actions github-actions bot added part:data-pipeline Affects the data pipeline part:actor Affects an actor ot the actors utilities (decorator, etc.) part:core Affects the SDK core components (data structures, etc.) part:microgrid Affects the interactions with the microgrid part:config Affects the configuration management labels Aug 30, 2023
@daniel-zullo-frequenz daniel-zullo-frequenz marked this pull request as ready for review August 30, 2023 12:01
@daniel-zullo-frequenz daniel-zullo-frequenz requested a review from a team as a code owner August 30, 2023 12:01
@daniel-zullo-frequenz daniel-zullo-frequenz added the cmd:skip-release-notes It is not necessary to update release notes for this PR label Aug 30, 2023
@daniel-zullo-frequenz daniel-zullo-frequenz force-pushed the fix/document-class-module-attributes branch from 450788a to dae107f Compare August 30, 2023 18:29
llucax
llucax reviewed Aug 30, 2023
View reviewed changes
Copy link
Contributor

@llucax llucax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few comments. Of course I didn't check if all missing attributes, etc. were documented. 😁

@daniel-zullo-frequenz daniel-zullo-frequenz force-pushed the fix/document-class-module-attributes branch 2 times, most recently from 7d8c9d1 to 2d674a0 Compare September 4, 2023 21:12
llucax
llucax reviewed Sep 5, 2023
View reviewed changes
Copy link
Contributor

@llucax llucax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few more nitpicking about "The ...".

@daniel-zullo-frequenz daniel-zullo-frequenz force-pushed the fix/document-class-module-attributes branch from 5c996f3 to 2763bc5 Compare September 5, 2023 08:38
@github-actions github-actions bot added the part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) label Sep 5, 2023
@daniel-zullo-frequenz daniel-zullo-frequenz force-pushed the fix/document-class-module-attributes branch from 2763bc5 to 1b21ce1 Compare September 5, 2023 08:38
@github-actions github-actions bot removed the part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) label Sep 5, 2023
@daniel-zullo-frequenz daniel-zullo-frequenz force-pushed the fix/document-class-module-attributes branch from 1b21ce1 to d4aef72 Compare September 5, 2023 10:24
@github-actions github-actions bot added the part:tests Affects the unit, integration and performance (benchmarks) tests label Sep 5, 2023
@shsms
Copy link
Contributor

shsms commented Sep 5, 2023

maybe "Rename variable name" -> "Rename variable" in first commit message?

llucax
llucax approved these changes Sep 5, 2023
View reviewed changes
Copy link
Contributor

@llucax llucax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only one minor comment about commits structure. LGTM. Thanks!

@daniel-zullo-frequenz
Rename variable according to the naming convention
7668d9d 
Signed-off-by: Daniel Zullo <daniel.zullo@frequenz.com>
@daniel-zullo-frequenz
Remove type variable no longer needed
b69163a 
Signed-off-by: Daniel Zullo <daniel.zullo@frequenz.com>
@daniel-zullo-frequenz
Fix typos in code documentation
f74221a 
Signed-off-by: Daniel Zullo <daniel.zullo@frequenz.com>
@daniel-zullo-frequenz
Document class and module attributes
73b00c1 
Add or amend docstrings for all classes and modules
where needed.

Signed-off-by: Daniel Zullo <daniel.zullo@frequenz.com>
@daniel-zullo-frequenz
Define regular attributes with default values
08bb756 
Pylint was complaining about documentation (pointless-string-statement)
for class attributes defined in the `__post_init__` method which
is not the recommended way to define attributes.

Signed-off-by: Daniel Zullo <daniel.zullo@frequenz.com>
@daniel-zullo-frequenz
Remove PV_ARRAY component category
f720979 
The PV_ARRAY component category is from the early
MicrogridData days and it is no longer.

Signed-off-by: Daniel Zullo <daniel.zullo@frequenz.com>
@daniel-zullo-frequenz daniel-zullo-frequenz force-pushed the fix/document-class-module-attributes branch from d4aef72 to f720979 Compare September 5, 2023 10:57
@daniel-zullo-frequenz daniel-zullo-frequenz added this pull request to the merge queue Sep 5, 2023
Merged via the queue into frequenz-floss:v0.x.x with commit 8da8583 Sep 5, 2023
@daniel-zullo-frequenz daniel-zullo-frequenz deleted the fix/document-class-module-attributes branch September 5, 2023 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@llucax llucax llucax approved these changes

@shsms shsms shsms left review comments

@matthias-wende-frequenz matthias-wende-frequenz Awaiting requested review from matthias-wende-frequenz matthias-wende-frequenz was automatically assigned from frequenz-floss/python-sdk-team

Assignees

@daniel-zullo-frequenz daniel-zullo-frequenz

Labels
cmd:skip-release-notes It is not necessary to update release notes for this PR part:actor Affects an actor ot the actors utilities (decorator, etc.) part:config Affects the configuration management part:core Affects the SDK core components (data structures, etc.) part:data-pipeline Affects the data pipeline part:microgrid Affects the interactions with the microgrid part:tests Affects the unit, integration and performance (benchmarks) tests
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document class, instance and module attributes
3 participants
@daniel-zullo-frequenz @shsms @llucax