Skip to content

ENG-2522: Update CommentType reply docstring to indicate reserved status#7407

Merged
JadeCara merged 2 commits intomainfrom
ENG-2522
Feb 19, 2026
Merged

ENG-2522: Update CommentType reply docstring to indicate reserved status#7407
JadeCara merged 2 commits intomainfrom
ENG-2522

Conversation

@JadeCara
Copy link
Contributor

@JadeCara JadeCara commented Feb 18, 2026

Ticket ENG-2522

Description Of Changes

Update the CommentType enum docstring to clarify that the reply type is reserved for future use and is not currently supported, replacing the previous description that implied reply comments were public and could trigger emails.

Code Changes

  • src/fides/api/models/comment.py - Updated CommentType docstring for the reply enum value

Steps to Confirm

  1. Review the docstring change in src/fides/api/models/comment.py on the CommentType class

Pre-Merge Checklist

  • Issue requirements met
  • All CI pipelines succeeded
  • CHANGELOG.md updated
    • Add a db-migration This indicates that a change includes a database migration label to the entry if your change includes a DB migration
    • Add a high-risk This issue suggests changes that have a high-probability of breaking existing code label to the entry if your change includes a high-risk change (i.e. potential for performance impact or unexpected regression) that should be flagged
    • Updates unreleased work already in Changelog, no new entry necessary
  • UX feedback:
    • All UX related changes have been reviewed by a designer
    • No UX review needed
  • Followup issues:
    • Followup issues created
    • No followup issues
  • Database migrations:
    • Ensure that your downrev is up to date with the latest revision on main
    • Ensure that your downgrade() migration is correct and works
      • If a downgrade migration is not possible for this change, please call this out in the PR description!
    • No migrations
  • Documentation:
    • Documentation complete, PR opened in fidesdocs
    • Documentation issue created in fidesdocs
    • If there are any new client scopes created as part of the pull request, remember to update public-facing documentation that references our scope registry
    • No documentation updates required

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@vercel
Copy link
Contributor

vercel bot commented Feb 18, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments
Project Deployment Actions Updated (UTC)
fides-plus-nightly Ignored Ignored Preview Feb 18, 2026 0:42am
fides-privacy-center Ignored Ignored Feb 18, 2026 0:42am

Request Review

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@JadeCara JadeCara marked this pull request as ready for review February 18, 2026 00:49
@JadeCara JadeCara requested a review from a team as a code owner February 18, 2026 00:49
@JadeCara JadeCara requested review from thabofletcher and removed request for a team February 18, 2026 00:49
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 18, 2026

Greptile Summary

Updates the CommentType enum docstring in src/fides/api/models/comment.py to clarify that the reply type is reserved for future use rather than being an active feature. The previous docstring incorrectly described reply comments as public and capable of triggering emails, which was misleading since the feature is not currently implemented (no usages of CommentType.reply exist in the codebase).

  • Updated docstring for reply enum value from "reply comments are public and may cause an email or other communciation to be sent" to "reply is reserved for future use and is not currently supported"
  • Added standard changelog entry
  • Note: The auto-generated TypeScript enum at clients/admin-ui/src/types/api/models/CommentType.ts still contains the old docstring and will be updated on the next OpenAPI type regeneration

Confidence Score: 5/5

  • This PR is safe to merge — it only changes a docstring with no functional impact.
  • The change is strictly a documentation update to a single docstring. No code logic, behavior, or tests are affected. The reply enum value itself is not modified, and no code in the codebase references CommentType.reply.
  • No files require special attention.

Important Files Changed

Filename Overview
src/fides/api/models/comment.py Docstring-only change: updated the reply enum description from implying active functionality to indicating it is reserved for future use.
changelog/7407-update-reply-comment-type-docstring.yaml Standard changelog entry following the project template format.

Last reviewed commit: 2d5523c

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

2 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

@JadeCara JadeCara added this pull request to the merge queue Feb 19, 2026
Merged via the queue into main with commit b967396 Feb 19, 2026
54 checks passed
@JadeCara JadeCara deleted the ENG-2522 branch February 19, 2026 19:41
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

Comments