docs: Fix MSB and LSB detector bit position descriptions#525
docs: Fix MSB and LSB detector bit position descriptions#525Nihal4777 merged 1 commit intoCircuitVerse:masterfrom
Conversation
WalkthroughThis 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)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
🧹 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".
Fixes #
Changes done:
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
Why This Matters
The previous descriptions were reversed and could confuse students learning digital logic.
The documentation previously had these reversed. As a student studying digital electronics, I noticed this error while reviewing.
Summary by CodeRabbit