Skip to content

docs: fix duplicated words in documentation#481

Merged
Nihal4777 merged 1 commit intoCircuitVerse:masterfrom
akshitvigg:fix/duplicate-words-docs
Jan 4, 2026
Merged

docs: fix duplicated words in documentation#481
Nihal4777 merged 1 commit intoCircuitVerse:masterfrom
akshitvigg:fix/duplicate-words-docs

Conversation

@akshitvigg
Copy link
Copy Markdown
Contributor

@akshitvigg akshitvigg commented Dec 30, 2025

Fixes #480

Changes Made

✅ Fixed duplicated word in docs/chapter5/usingsubcircuits.md (line 17)

  • Changed "Ideal circuit design flow for for an integrated effort" to "Ideal circuit design flow for an integrated effort"
  • Removed duplicate word "for" that impacted readability

✅ Fixed duplicated word in docs/chapter3/menubar.md (line 237)

  • Changed "construct the final circuit using different different gates" to "construct the final circuit using different gates"
  • Removed duplicate word "different" to improve documentation quality

Screenshots:

2025-12-30-165512_hyprshot 2025-12-30-165440_hyprshot

Preview Link(s):

✅️ By submitting this PR, I have verified the following

  • Checked to see if a similar PR has already been opened 🤔️
  • Reviewed the contributing guidelines 🔍️
  • Sample preview link added (add a link from the checks tab after checks complete)
  • Tried Squashing the commits into one

Summary by CodeRabbit

  • Documentation
    • Corrected duplicate words and grammatical errors in chapters 3 and 5 documentation to enhance clarity and readability.

✏️ Tip: You can customize this high-level summary in your review settings.

- Remove duplicate 'for' in usingsubcircuits.md caption
- Remove duplicate 'different' in menubar.md
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Dec 30, 2025

Walkthrough

Two documentation files corrected duplicate words: removed redundant "different" in menubar.md and "for" in usingsubcircuits.md. Both changes are minor textual corrections with no impact on content structure or meaning.

Changes

Cohort / File(s) Summary
Documentation typo fixes
docs/chapter3/menubar.md, docs/chapter5/usingsubcircuits.md
Removed duplicate words: "different different" → "different" in menubar.md (line 237); "for for" → "for" in usingsubcircuits.md figure caption (line 17)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • Nihal4777

Pre-merge checks

✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately summarizes the main change: fixing duplicated words in documentation files.
Linked Issues check ✅ Passed The PR fully addresses all requirements from issue #480: duplicate 'for' removed in usingsubcircuits.md line 17 and duplicate 'different' removed in menubar.md line 237.
Out of Scope Changes check ✅ Passed All changes are directly scoped to fixing duplicated words in the two specified files; no unrelated modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bace6c5 and b360f16.

📒 Files selected for processing (2)
  • docs/chapter3/menubar.md
  • docs/chapter5/usingsubcircuits.md
🔇 Additional comments (2)
docs/chapter3/menubar.md (1)

237-237: Duplicate word removed correctly.

The redundant "different" has been properly removed, and the sentence now reads clearly: "construct the final circuit using different gates and circuit elements."

docs/chapter5/usingsubcircuits.md (1)

17-17: Duplicate word removed correctly.

The redundant "for" has been properly removed from the figure caption, which now reads: "Figure 5.1: Ideal circuit design flow for an integrated effort while using subcircuits within CircuitVerse."


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link
Copy Markdown
Member

@Nihal4777 Nihal4777 left a comment

Choose a reason for hiding this comment

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

Thanks @akshitvigg.

@Nihal4777 Nihal4777 merged commit 949a902 into CircuitVerse:master Jan 4, 2026
5 of 8 checks passed
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.

Fix duplicated words in documentation files

2 participants