Skip to content

docs: remove duplicated article in NER dedupe-key docstring - #794

Open
Avicennasis wants to merge 1 commit into
NVIDIA-NeMo:mainfrom
TypoScan3000:docs/fix-typos
Open

Avicennasis wants to merge 1 commit into
NVIDIA-NeMo:mainfrom
TypoScan3000:docs/fix-typos

Conversation

@Avicennasis

@Avicennasis Avicennasis commented Oct 26, 2026 •

Copy link
Copy Markdown

Summary

  • src/nemo_safe_synthesizer/pii_replacer/ner/ner.py: in the get_dedupe_key_by_label docstring, Returns: read A a tuple of unique values .... It now reads A tuple of unique values ....

Human review

  • ⚪ No human review; automated review only
  • 🟡 Partially reviewed or spot-checked by a human
  • 🔵 Complete diff reviewed by a human
  • 🟢 Complete diff reviewed and verified by a human

Verification performed: an AI agent confirmed the duplicated article in the file at main and checked that the one-line diff touches only the docstring. The commit is signed (GPG) and signed off (DCO).

Disclosure: these issues were flagged by an automated typo scanner (TypoScan3000); each one was checked against the current file on the default branch, and the edits were prepared with AI assistance.

No functional changes — docstring only.

Summary by CodeRabbit

  • Documentation
    • Corrected a grammatical error in a code comment.

Signed-off-by: Léon Avic Simmons <Avicennasis@gmail.com>
@Avicennasis
Avicennasis requested a review from a team as a code owner October 26, 2026 04:10
@coderabbitai

coderabbitai Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 48a2c2a and 86d29bf.

Files selected for processing: 1
  • src/nemo_safe_synthesizer/pii_replacer/ner/ner.py

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.

Recent review details
Additional context used
Code guidelines: 3
CONTRIBUTING.md — configured
STYLE_GUIDE.md — configured
AGENTS.md — configured
Path-based instructions: 7
Treat PII replacement changes as high-risk.

CodeRabbit configuration file

Files:

  • src/nemo_safe_synthesizer/pii_replacer/ner/ner.py
Review library code against STYLE_GUIDE.md.

CodeRabbit configuration file

Files:

  • src/nemo_safe_synthesizer/pii_replacer/ner/ner.py
Review as a senior maintainer for NeMo Safe Synthesizer.

CodeRabbit configuration file

Files:

  • src/nemo_safe_synthesizer/pii_replacer/ner/ner.py
Source excerpt: All source files (`.py`, `.sh`, `.yaml`, `.yml`, `.md`) require SPDX copyright headers.

CodeRabbit inference engine (CONTRIBUTING.md)

Files:

  • src/nemo_safe_synthesizer/pii_replacer/ner/ner.py
Applicability reference: AGENTS.md: # AGENTS.md See [STYLE_GUIDE.md](STYLE_GUIDE.md) for detailed code style conventions (Python, markdown, Dockerfiles, shell scripts, testing, config files, docstrings).

CodeRabbit inference engine (STYLE_GUIDE.md)

Files:

  • src/nemo_safe_synthesizer/pii_replacer/ner/ner.py
Source excerpt: API reference pages are auto-generated from Python docstrings.

CodeRabbit inference engine (CONTRIBUTING.md)

Files:

  • src/nemo_safe_synthesizer/pii_replacer/ner/ner.py
Source excerpt: Use `uv` for everything -- never `pip` or raw `python`.

CodeRabbit inference engine (AGENTS.md)

Files:

  • src/nemo_safe_synthesizer/pii_replacer/ner/ner.py
Additional comments: 1
src/nemo_safe_synthesizer/pii_replacer/ner/ner.py: 1

78-78: LGTM!

Walkthrough

The docstring for get_dedupe_key_by_label changes from “A a tuple” to “A tuple.” Runtime behavior does not change.

Changes

Docstring correction

Layer / File(s) Summary
Correct docstring wording
src/nemo_safe_synthesizer/pii_replacer/ner/ner.py
The docstring now uses “A tuple” instead of “A a tuple.”

Priority: Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other · Severity of issue fixed: Low

Suggested labels: docs

Suggested reviewers: binaryaaron

Merge Risk: Minimal · up to 86d29

This documentation-only change is safe to merge.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the documentation change: removing the duplicated article from the NER dedupe-key docstring.
Docstring Coverage Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@greptile-apps

greptile-apps Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] This docstring-only correction is safe to merge.

Summary

Corrects “A a tuple” to “A tuple” in the get_dedupe_key_by_label docstring.

  • The dedupe-key description no longer repeats an article.

Reviews (1) · Last reviewed commit: "docs: remove duplicated article in NER d..." · Reviewed by Greptile

@coderabbitai coderabbitai Bot added the docs Documentation-only change label Oct 26, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:pii docs Documentation-only change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant