Skip to content

Clarify Documentation for Task Deletion Parameters#12

Open
YahyaLafdi wants to merge 1 commit intoqarnot:masterfrom
YahyaLafdi:doc-delete-task
Open

Clarify Documentation for Task Deletion Parameters#12
YahyaLafdi wants to merge 1 commit intoqarnot:masterfrom
YahyaLafdi:doc-delete-task

Conversation

@YahyaLafdi
Copy link

PR Description

This PR updates the docstring for the delete method to provide clearer explanations for the purge_resources and purge_results parameters.

Changes:

  • Clarified that purge_resources refers to the deletion of the resources bucket.
  • Clarified that purge_results refers to the deletion of the results (output) bucket.

These changes improve readability and eliminate ambiguity in the documentation.

### PR Description

This PR updates the docstring for the `delete` method to provide clearer explanations for the `purge_resources` and `purge_results` parameters. 

#### Changes:
- Clarified that `purge_resources` refers to the deletion of the resources bucket.
- Clarified that `purge_results` refers to the deletion of the results (output) bucket.

These changes improve readability and eliminate ambiguity in the documentation.
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.

1 participant