Skip to content

docs: fix the bold wordings #529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ShinichiShi wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: fix the bold wordings #529

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/chapter3/properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Properties page in Chapter3 of CircuitVerse documentation."

# 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

@coderabbitai coderabbitai Bot Feb 25, 2026

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: the → The

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.


- Adding labels across different nodes.
- Including text boxes for displaying the version number, date, amendments and different group members involved.
Expand Down Expand Up @@ -130,7 +130,7 @@ Table 3.7: Brief description of the different properties available for different

## 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

@coderabbitai coderabbitai Bot Feb 25, 2026

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).


![drawing](/img/img_chapter3/3.14.png)

Expand Down