Skip to content

fix: clean up canonical function formatting#795

Open
vamshikrishnaramasamy wants to merge 1 commit into
CircuitVerse:masterfrom
vamshikrishnaramasamy:fix/issue-718-canonical-formatting
Open

fix: clean up canonical function formatting#795
vamshikrishnaramasamy wants to merge 1 commit into
CircuitVerse:masterfrom
vamshikrishnaramasamy:fix/issue-718-canonical-formatting

Conversation

@vamshikrishnaramasamy

@vamshikrishnaramasamy vamshikrishnaramasamy commented Jun 21, 2026

Copy link
Copy Markdown

Summary

  • replace the malformed intro example block with a plain text example
  • remove the stray Truth Table:: punctuation
  • rename the duplicate truth table heading for the three-variable example

Closes #718

Tests

  • git diff --check

Could not run bundle exec jekyll build -d out locally because this machine has system Ruby 2.6 and lacks the locked Bundler 2.4.22 toolchain.

Summary by CodeRabbit

  • Documentation
    • Improved formatting and structure of the Boolean functions and truth table documentation for better clarity and readability.

@coderabbitai

coderabbitai Bot commented Jun 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 95d283f6-26b1-4907-8e5c-dcc127676fa4

📥 Commits

Reviewing files that changed from the base of the PR and between 0afa9b9 and 858f357.

📒 Files selected for processing (1)
  • docs/logic-design/canonical.md

Walkthrough

The pull request updates docs/logic-design/canonical.md to address formatting issues in the Canonical functions page. The shorthand Boolean function example block is replaced with a properly fenced Markdown code snippet displaying F(A, B) and F(A, B, C) assignments. The "Truth Table::" label is normalized to "Truth table:" with standard punctuation. The section heading "Truth table formation" is renamed to "Three-variable truth table example." A minor trailing whitespace or blank-line adjustment is also applied near the end of the document.

Possibly related PRs

  • CircuitVerse/Interactive-Book#785: Also modifies docs/logic-design/canonical.md with truth-table formatting corrections, directly overlapping with this PR's changes to the same file and section.
🚥 Pre-merge checks | ✅ 5
✅ 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 accurately describes the main change: fixing and cleaning up formatting in the canonical functions documentation file.
Linked Issues check ✅ Passed The PR resolves the formatting issues reported in issue #718 by fixing the malformed example block, removing stray punctuation, and renaming duplicate headings.
Out of Scope Changes check ✅ Passed All changes are directly related to fixing the formatting issues in the canonical functions documentation as specified in issue #718; no out-of-scope modifications detected.
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

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.

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.

Bug: Formatting issue in the page Canonical functions

1 participant