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

Add descriptions for plugins #56

Draft
wants to merge 4 commits into
base: devel
Choose a base branch
from

Conversation

djyasin
Copy link
Member

@djyasin djyasin commented Nov 14, 2024

Add descriptions for plugins

@djyasin djyasin force-pushed the update_cloud_providers_and_cloud_constants_28722 branch from 9f9b356 to d86e798 Compare November 14, 2024 21:41
@@ -1,5 +1,5 @@
# FIXME: the following violations must be addressed gradually and unignored
# mypy: disable-error-code="assignment, no-untyped-call, no-untyped-def, var-annotated"
# mypy: disable-error-code='assignment, no-untyped-call, no-untyped-def, var-annotated'
Copy link
Member

Choose a reason for hiding this comment

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

I'm assuming a misconfigured code editor made a bunch of invasive changes, eh?

Copy link
Member Author

Choose a reason for hiding this comment

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

I ran black on this before I committed and it reformatted everything- I am going to pull out those changes today!

Copy link
Member

Choose a reason for hiding this comment

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

Why didn't you run the automation that is integrated into the repo instead?

@djyasin djyasin force-pushed the update_cloud_providers_and_cloud_constants_28722 branch from 7af9475 to ae262fa Compare November 15, 2024 14:52
Copy link
Member

@webknjaz webknjaz left a comment

Choose a reason for hiding this comment

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

Does this still need to remain a draft?

P.S. Note that all of the revert+fixup+wip commit titles will end up on devel.

Comment on lines +21 to +22
plugin_description = None
# this field is for the description of the injector
Copy link
Member

Choose a reason for hiding this comment

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

In general, comments should be on the same line if possible:

Suggested change
plugin_description = None
# this field is for the description of the injector
plugin_description = None # this field holds the injector description

This is because over time, the comment line and the code line may drift away from each other by accident. And the comments will end up being in weird places.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants