Skip to content

docs: fix the bold wordings#529

Open
ShinichiShi wants to merge 1 commit intoCircuitVerse:masterfrom
ShinichiShi:fix-bold-text
Open

docs: fix the bold wordings#529
ShinichiShi wants to merge 1 commit intoCircuitVerse:masterfrom
ShinichiShi:fix-bold-text

Conversation

@ShinichiShi
Copy link
Copy Markdown

@ShinichiShi ShinichiShi commented Feb 25, 2026

Fixes #528

Ref #

Changes done:

  • Updated the readme file properties.md to remove the missing spaces to fit in the bold styling

Screenshots:

image

Preview Link(s):

https://docs.circuitverse.org/chapter3/chapter3-properties/#edit-circuit-layout

✅️ 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
    • Corrected formatting inconsistencies for UI element references throughout the documentation.
    • Added guidance on using rectangular boxes to highlight different sections when working with complex designs.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Feb 25, 2026

Walkthrough

This pull request fixes formatting issues in the properties documentation file. Two instances of inline bold text formatting were corrected by removing trailing spaces after the text in the PROPERTIES panel and Edit Layout button label references. Additionally, a new bullet point was added to the properties feature list describing the capability to add rectangular boxes for highlighting different sections in complex designs. The changes address documentation accuracy with minimal modifications to the file.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Out of Scope Changes check ❓ Inconclusive The PR includes fixing inline bold formatting and adding a new bullet point about rectangular boxes, which appears slightly beyond the original issue scope. Clarify whether the new bullet about rectangular boxes for highlighting sections was part of issue #528 or is a separate enhancement.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: fix the bold wordings' clearly and concisely summarizes the primary change: fixing bold formatting in documentation.
Linked Issues check ✅ Passed The PR directly addresses issue #528 by fixing bold formatting in properties.md, correcting the markdown syntax for bold text rendering.
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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/chapter3/properties.md`:
- Line 133: In the sentence describing Figure 3.14 on the properties page (the
line mentioning the "Edit Layout" button in the "PROPERTIES" panel), remove the
stray space immediately before the closing parenthesis so the phrase reads
"...main circuit)" instead of "...main circuit )"; update the text accordingly
where that sentence appears (look for the string "Edit Layout", "PROPERTIES",
and "Figure 3.14" to locate the exact spot).
- Line 9: Locate the sentence "it also includes parameters for annotation. the
circuit schematic can be annotated by:" and change the lowercase "the" after the
period to an uppercase "The" so it reads "...parameters for annotation. The
circuit schematic can be annotated by:". Also scan the surrounding sentences in
the same paragraph for any other sentence-case errors and correct them to start
with an uppercase letter after periods.

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f6deeb5 and b8f62b1.

📒 Files selected for processing (1)
  • docs/chapter3/properties.md

# Properties Panel

Each circuit element has some properties associated with itself which are displayed in the **PROPERTIES **panel. Besides including different parameters for creating multi-bit circuits, it also includes parameters for annotation. the circuit schematic can be annotated by:
Each circuit element has some properties associated with itself which are displayed in the **PROPERTIES** panel. Besides including different parameters for creating multi-bit circuits, it also includes parameters for annotation. the circuit schematic can be annotated by:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix sentence-case after period: theThe

The bold fix is correct. However, the same sentence contains a lowercase the starting what should be a new sentence after the period.

✏️ Proposed fix
-Each circuit element has some properties associated with itself which are displayed in the **PROPERTIES** panel. Besides including different parameters for creating multi-bit circuits, it also includes parameters for annotation. the circuit schematic can be annotated by:
+Each circuit element has some properties associated with itself which are displayed in the **PROPERTIES** panel. Besides including different parameters for creating multi-bit circuits, it also includes parameters for annotation. The circuit schematic can be annotated by:
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Each circuit element has some properties associated with itself which are displayed in the **PROPERTIES** panel. Besides including different parameters for creating multi-bit circuits, it also includes parameters for annotation. the circuit schematic can be annotated by:
Each circuit element has some properties associated with itself which are displayed in the **PROPERTIES** panel. Besides including different parameters for creating multi-bit circuits, it also includes parameters for annotation. The circuit schematic can be annotated by:
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/chapter3/properties.md` at line 9, Locate the sentence "it also includes
parameters for annotation. the circuit schematic can be annotated by:" and
change the lowercase "the" after the period to an uppercase "The" so it reads
"...parameters for annotation. The circuit schematic can be annotated by:". Also
scan the surrounding sentences in the same paragraph for any other sentence-case
errors and correct them to start with an uppercase letter after periods.

## Edit Circuit Layout

As shown in Figure 3.14, the **Edit Layout **button available on the **PROPERTIES **panel converts the circuit into a black box. The circuit elements and the relevant connections are hidden whereas the input and output pins are displayed (in the same order as displayed in the main circuit ).
As shown in Figure 3.14, the **Edit Layout** button available on the **PROPERTIES** panel converts the circuit into a black box. The circuit elements and the relevant connections are hidden whereas the input and output pins are displayed (in the same order as displayed in the main circuit ).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Remove stray space before closing parenthesis

The bold fixes are correct. There is also a stray space before ) at the end of the sentence.

✏️ Proposed fix
-As shown in Figure 3.14, the **Edit Layout** button available on the **PROPERTIES** panel converts the circuit into a black box. The circuit elements and the relevant connections are hidden whereas the input and output pins are displayed (in the same order as displayed in the main circuit ).
+As shown in Figure 3.14, the **Edit Layout** button available on the **PROPERTIES** panel converts the circuit into a black box. The circuit elements and the relevant connections are hidden whereas the input and output pins are displayed (in the same order as displayed in the main circuit).
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
As shown in Figure 3.14, the **Edit Layout** button available on the **PROPERTIES** panel converts the circuit into a black box. The circuit elements and the relevant connections are hidden whereas the input and output pins are displayed (in the same order as displayed in the main circuit ).
As shown in Figure 3.14, the **Edit Layout** button available on the **PROPERTIES** panel converts the circuit into a black box. The circuit elements and the relevant connections are hidden whereas the input and output pins are displayed (in the same order as displayed in the main circuit).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/chapter3/properties.md` at line 133, In the sentence describing Figure
3.14 on the properties page (the line mentioning the "Edit Layout" button in the
"PROPERTIES" panel), remove the stray space immediately before the closing
parenthesis so the phrase reads "...main circuit)" instead of "...main circuit
)"; update the text accordingly where that sentence appears (look for the string
"Edit Layout", "PROPERTIES", and "Figure 3.14" to locate the exact spot).

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.

Bold styling of words missing

1 participant