docs: fix typo in max term definition (product → sum)#724
docs: fix typo in max term definition (product → sum)#724bhavish00007 wants to merge 1 commit intoCircuitVerse:masterfrom
Conversation
WalkthroughCorrects a definition in docs/logic-design/canonical.md: updates the Maxterms description from “product of n variables” to “sum of n variables.” No other sections or examples were changed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks (5 passed)✅ Passed checks (5 passed)
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. ✨ Finishing Touches🧪 Generate unit tests
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.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/logic-design/canonical.md (1)
174-174: Switch bold style to underscores and tighten wording (markdownlint MD050).Adopt underscores for strong emphasis and clarify the “i” range.
Apply this diff:
-A max term is defined as the sum of n variables, within the range of 0 ≤ i < 2<sup>n</sup>. The max term is denoted as Mi. In max term, each variable is **complemented**, if its value is assigned to 1, and each variable is **un-complemented** if its value is assigned to 0. +A max term is defined as the sum of n variables, where i is in the range 0 ≤ i < 2<sup>n</sup>. The max term is denoted as Mi. In a max term, each variable is __complemented__ if its value is assigned to 1, and each variable is __uncomplemented__ if its value is assigned to 0.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/logic-design/canonical.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/logic-design/canonical.md
174-174: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
174-174: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
174-174: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
174-174: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
🔇 Additional comments (1)
docs/logic-design/canonical.md (1)
174-174: Correct fix: Maxterm is a sum (not a product).The change aligns with standard logic design terminology.
Fixes #723
Changes done:
canonical.md(Line 174)Screenshots
Not applicable (documentation-only change)
Preview Link(s):
Interactive Book → Logic Design → Canonical Forms
✅️ By submitting this PR, I have verified the following
Thank You
Summary by CodeRabbit