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

Docs: docstring of verdi group delete command can be confusing #4356

Closed
ltalirz opened this issue Sep 4, 2020 · 1 comment
Closed

Docs: docstring of verdi group delete command can be confusing #4356

ltalirz opened this issue Sep 4, 2020 · 1 comment

Comments

@ltalirz
Copy link
Member

ltalirz commented Sep 4, 2020

This is the current docstring of verdi group delete:

"""Delete a group.
Note that a group that contains nodes cannot be deleted if it contains any nodes. If you still want to delete the
group, use the `-c/--clear` flag to remove the contents before deletion. Note that in any case, the nodes themselves
will not actually be deleted from the database.
"""

The differentiation between a node being removed from a group and a node being deleted is unclear.
Furthermore, the docstring is inconsistent in itself & contains unnecessary repetitions.

Will provide a suggestion for improvement.

@ltalirz
Copy link
Member Author

ltalirz commented Jan 27, 2021

this was fixed in #4357

@ltalirz ltalirz closed this as completed Jan 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant