Skip to content

docs: Fix MSB and LSB detector bit position descriptions#525

Merged
Nihal4777 merged 1 commit intoCircuitVerse:masterfrom
sharanyas06:fix-msb-lsb-description
Feb 21, 2026
Merged

docs: Fix MSB and LSB detector bit position descriptions#525
Nihal4777 merged 1 commit intoCircuitVerse:masterfrom
sharanyas06:fix-msb-lsb-description

Conversation

@sharanyas06
Copy link
Copy Markdown
Contributor

@sharanyas06 sharanyas06 commented Feb 18, 2026

Fixes #

Changes done:

  • Fixed MSB Detector description (changed "rightmost" to "leftmost")
  • Fixed LSB Detector description (changed "leftmost" to "rightmost")

Screenshots:

N/A - Text-only documentation fix

Preview Link(s):

Will be added after checks complete

✅️ 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

Why This Matters

The previous descriptions were reversed and could confuse students learning digital logic.

  • MSB (Most Significant Bit) is the leftmost bit (highest place value)
  • LSB (Least Significant Bit) is the rightmost bit (lowest place value)

The documentation previously had these reversed. As a student studying digital electronics, I noticed this error while reviewing.

Summary by CodeRabbit

  • Documentation
    • Corrected textual descriptions for MSB and LSB detector documentation to accurately reflect bit positions.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 18, 2026

Walkthrough

This pull request contains corrections to textual descriptions in the documentation file for multiplexer and demultiplexer content. Specifically, the MSB detector description is updated to reference "leftmost bit" instead of "rightmost bit," while the LSB detector description is corrected to reference "rightmost bit" instead of "leftmost bit." These changes affect only the descriptive text and do not alter any functional logic or structural elements.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and accurately describes the main change: correcting MSB and LSB detector bit position descriptions in the documentation.
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

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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.

🧹 Nitpick comments (1)
docs/chapter4/5muxandplex.md (1)

257-257: Correction is accurate — consider tightening "leftmost bit" to "leftmost set bit".

The swap from "rightmost" to "leftmost" for MSB is correct per standard binary convention. A minor precision gap remains: the MSB detector locates the highest active (set) bit, not the unconditionally leftmost bit. For input 0110 (4-bit), it outputs position 2, not position 3. Since the "In other words" clause is meant as a student-friendly clarifier, "leftmost set bit" (and "rightmost set bit" for LSB on line 276) would be more accurate.

✏️ Optional wording improvement
-The **Most Significant Bit (MSB)** detector circuit element outputs the bit position of the most significant bit of the input. In other words, it outputs the bit position of the leftmost bit.
+The **Most Significant Bit (MSB)** detector circuit element outputs the bit position of the most significant active bit of the input. In other words, it outputs the bit position of the leftmost set bit.
-The **Least Significant Bit (LSB)** detector circuit element outputs the bit position of the least significant bit of the input. In other words, it outputs the bit position of the rightmost bit.
+The **Least Significant Bit (LSB)** detector circuit element outputs the bit position of the least significant active bit of the input. In other words, it outputs the bit position of the rightmost set bit.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/chapter4/5muxandplex.md` at line 257, Update the descriptive text for
the MSB detector: change the phrase "leftmost bit" to "leftmost set bit" in the
MSB detector paragraph (the sentence starting "In other words, it outputs the
bit position of the leftmost bit.") to make clear it finds the highest active
bit; also mirror this precision for the LSB description (the LSB paragraph
around the later sentence) by replacing "rightmost bit" with "rightmost set
bit".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/chapter4/5muxandplex.md`:
- Line 257: Update the descriptive text for the MSB detector: change the phrase
"leftmost bit" to "leftmost set bit" in the MSB detector paragraph (the sentence
starting "In other words, it outputs the bit position of the leftmost bit.") to
make clear it finds the highest active bit; also mirror this precision for the
LSB description (the LSB paragraph around the later sentence) by replacing
"rightmost bit" with "rightmost set bit".

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.

Good catch @sharanyas06. Thanks.🙌

@Nihal4777 Nihal4777 merged commit 41f863c into CircuitVerse:master Feb 21, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants