Skip to content

Conversation

@neuark
Copy link

@neuark neuark commented Oct 17, 2025

Just fixed a typo .

Fix #18338

Change completed to complete.

Contributed by @neuark .

change completed to complete
@neuark neuark requested a review from a team as a code owner October 17, 2025 16:59
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

The following fields are returned in the JSON response body:

- `status` - string - one of scheduled/active/completed/failed, indicating the status of the redaction job
- `status` - string - one of scheduled/active/complete/failed, indicating the status of the redaction job
Copy link
Contributor

Choose a reason for hiding this comment

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

I assume this corresponds to TaskStatus

class TaskStatus(str, Enum):
"""Status of a scheduled task"""
# Task is scheduled but not active
SCHEDULED = "scheduled"
# Task is active and probably running, and if not
# will be run on next scheduler loop run
ACTIVE = "active"
# Task has completed successfully
COMPLETE = "complete"
# Task is over and either returned a failed status, or had an exception
FAILED = "failed"

If we're going to use the actual values, we should probably use some code snippets for them:

Suggested change
- `status` - string - one of scheduled/active/complete/failed, indicating the status of the redaction job
- `status` - string - one of `scheduled`/`active`/`complete`/`failed`, indicating the status of the redaction job

Copy link
Author

Choose a reason for hiding this comment

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

i don't know it was my first PR



**Response**

Copy link
Contributor

@MadLittleMods MadLittleMods Oct 17, 2025

Choose a reason for hiding this comment

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

Per the PR checklist (was in the PR description template), this needs a changelog entry -> changelog.d/19072.doc

  • Pull request includes a changelog file. The entry should:
    • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
    • Use markdown where necessary, mostly for code blocks.
    • End with either a period (.) or an exclamation mark (!).
    • Start with a capital letter.
    • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.

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.

Typo in documentation for the user redaction endpoint

3 participants