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

Document class and module attributes #185

Conversation

daniel-zullo-frequenz
Copy link
Contributor

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

Fixes #31

@github-actions github-actions bot added part:tests Affects the unit, integration and performance (benchmarks) tests part:channels Affects channels implementation part:synchronization Affects the synchronization of multiple sources (`select`, `merge`) part:core Affects the core types (`Sender`, `Receiver`, exceptions, etc.) labels Sep 14, 2023
@daniel-zullo-frequenz daniel-zullo-frequenz added the cmd:skip-release-notes It is not necessary to update release notes for this PR label Sep 14, 2023
@daniel-zullo-frequenz daniel-zullo-frequenz self-assigned this Sep 14, 2023
@daniel-zullo-frequenz daniel-zullo-frequenz marked this pull request as ready for review September 14, 2023 10:08
@daniel-zullo-frequenz daniel-zullo-frequenz requested a review from a team as a code owner September 14, 2023 10:08
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 small comments and a few improvements that we might want to make before 1.0 as they are breaking changes 😞 (I created new issues for them).

src/frequenz/channels/_anycast.py Outdated Show resolved Hide resolved
src/frequenz/channels/_anycast.py Show resolved Hide resolved
src/frequenz/channels/_base_classes.py Show resolved Hide resolved
src/frequenz/channels/_bidirectional.py Show resolved Hide resolved
src/frequenz/channels/_broadcast.py Outdated Show resolved Hide resolved
src/frequenz/channels/_broadcast.py Outdated Show resolved Hide resolved
src/frequenz/channels/_broadcast.py Outdated Show resolved Hide resolved
@daniel-zullo-frequenz daniel-zullo-frequenz force-pushed the fix/amend-documentation branch 2 times, most recently from 4020f21 to 1ca6a8f Compare September 18, 2023 11:02
@github-actions github-actions bot added the part:docs Affects the documentation label Sep 18, 2023
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.

Not sure why did you remove the limit in the PR. The rest LGTM.

Also, could you not mark conversations I started as resolved? If you do so, I need to go expanding them one by one to see your replies and to remember what comments I made to go see in the code how it was addressed. If you need to keep track of which comments you already addressed, you can use a reaction instead, like 👍 .

RELEASE_NOTES.md Outdated Show resolved Hide resolved
Signed-off-by: Daniel Zullo <daniel.zullo@frequenz.com>
Add or amend docstrings for all classes and modules where needed.

Signed-off-by: Daniel Zullo <daniel.zullo@frequenz.com>
@github-actions github-actions bot removed the part:docs Affects the documentation label Sep 18, 2023
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.

Thanks!

@daniel-zullo-frequenz daniel-zullo-frequenz added this pull request to the merge queue Sep 19, 2023
Merged via the queue into frequenz-floss:v0.x.x with commit ef2dde8 Sep 19, 2023
@daniel-zullo-frequenz daniel-zullo-frequenz deleted the fix/amend-documentation branch September 19, 2023 07:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cmd:skip-release-notes It is not necessary to update release notes for this PR part:channels Affects channels implementation part:core Affects the core types (`Sender`, `Receiver`, exceptions, etc.) part:synchronization Affects the synchronization of multiple sources (`select`, `merge`) part:tests Affects the unit, integration and performance (benchmarks) tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add class/instance and module attributes/properties documentation
2 participants