Skip to content

Added controlled inverter docs#513

Merged
Nihal4777 merged 3 commits intoCircuitVerse:masterfrom
Audatic07:controlled-inverter#342
Feb 11, 2026
Merged

Added controlled inverter docs#513
Nihal4777 merged 3 commits intoCircuitVerse:masterfrom
Audatic07:controlled-inverter#342

Conversation

@Audatic07
Copy link
Copy Markdown
Contributor

@Audatic07 Audatic07 commented Feb 10, 2026

Fixes #342

Ref #

Changes done:

  • Task 1

Screenshots:

image image

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
    • Added a "Controlled Inverter" section with description, truth table, and interactive circuit example.
    • Reordered Chapter 4 miscellaneous navigation to a new sequence (Controlled Inverter, TriState Buffer, Tunnel, Splitter, Equal Split, Unequal Split, Flag, Two's Complement).
    • Updated TriState Buffer table numbering and adjusted surrounding references and layout.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 10, 2026

Walkthrough

The chapter 4 miscellaneous components documentation was updated to add a new "Controlled Inverter" section (gated inverter with an Enable input and high‑impedance output when disabled), insert an embedded live circuit and truth table, and reorder the miscellaneous navigation entries to include Controlled Inverter before TriState Buffer. The TriState Buffer truth table was renumbered to Table 4.25 and an image reference was removed. Changes: +60/−8 lines.

🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning The PR includes a minor out-of-scope change: updating the TriState Buffer truth table numbering from Table 4.24 to Table 4.25, which is a secondary adjustment not mentioned in the linked issue #342. Isolate the TriState Buffer table renumbering into a separate PR or document the rationale for this adjustment as a necessary consequence of adding the new Controlled Inverter content.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'Added controlled inverter docs' clearly and specifically summarizes the main change: adding documentation for the Controlled Inverter component.
Linked Issues check ✅ Passed The PR successfully implements all coding requirements from issue #342: adds Controlled Inverter documentation with behavior description, truth table (Table 4.24), properties notes (Direction, BitWidth), and live circuit embed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/chapter4/8misc.md`:
- Around line 319-369: The TriState Buffer section contains an orphaned caption
"Figure 4.19: Relevant attributes for the TriState circuit element" with no
preceding image; either insert the missing image/figure markup right before that
caption (e.g., an <img> or figure block showing the TriState attributes) or
remove the caption line entirely; locate the text by searching for the "TriState
Buffer" heading and the exact caption string "Figure 4.19: Relevant attributes
for the TriState circuit element" and update accordingly so the caption is not
left without an image.
🧹 Nitpick comments (1)
docs/chapter4/8misc.md (1)

319-369: Great documentation! Consider iframe formatting consistency.

The Controlled Inverter documentation is well-structured and accurate. The truth table correctly represents the component's behavior (inversion when enabled, high impedance when disabled).

Minor formatting inconsistency: The embedded iframe at line 368 uses width="500" height="500" with inline styles, while other iframes in the document consistently use width="600px" height="400px" with standard attributes. Consider standardizing for consistency.

Optional style refinement: Lines 323-326 have three consecutive sentences beginning with "If", which slightly affects readability. Consider rewording the third sentence, e.g., "Users can change the orientation..." or "As needed, users may change...".

🎨 Suggested iframe formatting for consistency
-<iframe src="https://circuitverse.org/simulator/embed/controlled-inverter-192f44be-551e-4204-b495-ef7234705575?theme=&display_title=false&clock_time=true&fullscreen=true&zoom_in_out=true" style="border-width:; border-style: ; border-color:;" name="myiframe" id="projectPreview" scrolling="no" frameborder="1" marginheight="0px" marginwidth="0px" height="500" width="500" allowFullScreen></iframe>
+<iframe
+  width="600px"
+  height="400px"
+  src="https://circuitverse.org/simulator/embed/controlled-inverter-192f44be-551e-4204-b495-ef7234705575"
+  id="projectPreview"
+  scrolling="no"
+  webkitAllowFullScreen
+  mozAllowFullScreen
+  allowFullScreen
+>
+  {" "}
+</iframe>

Comment thread docs/chapter4/8misc.md
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/chapter4/8misc.md`:
- Line 368: The iframe element (id="projectPreview", name="myiframe") is missing
a descriptive title for screen readers; add a meaningful title attribute (e.g.,
title="Controlled inverter circuit preview") to the iframe tag so assistive tech
can identify the embedded circuit, ensuring the title succinctly describes the
content and purpose.
🧹 Nitpick comments (1)
docs/chapter4/8misc.md (1)

330-364: Clarify what “Z” means in the truth table.

Consider a short note before/after the table so readers unfamiliar with tri‑state notation understand that “Z” means high‑impedance.

💡 Suggested tweak
 Table 4.24: Truth table for a Controlled Inverter gate

+> Note: **Z** denotes a high‑impedance (disconnected) output.
+
 <table>

Comment thread docs/chapter4/8misc.md Outdated
@Audatic07
Copy link
Copy Markdown
Contributor Author

@Nihal4777 please review and merge :)

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 @Audatic07 🙌

@Nihal4777 Nihal4777 merged commit b0af31e into CircuitVerse:master Feb 11, 2026
8 checks passed
@Audatic07 Audatic07 deleted the controlled-inverter#342 branch February 14, 2026 18: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.

Add documentation for Controlled Inverter

2 participants