[Docs] Added Query Commands to SDC Syntax Docs

[AlexandreSinger]

Continued to add to the syntax coverage docs by adding more details for the commands which query timing and netlist objects.

Summary by CodeRabbit

• Documentation
  • Restructured Query section with clearer subheadings and separate subsections for ports, clocks, pins, cells, nets, and collective inputs/outputs/clocks.
  • Added usage examples for each query subsection and a note on hierarchical flags for OpenSTA to improve clarity and usability.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Restructures the Query section in docs/syntax/README.md: lowers the Query heading level, adds labeled subsections for specific query commands (get_ports, get_clocks, get_pins, get_cells, get_nets, all_inputs, all_outputs, all_clocks), includes usage examples and a note about hierarchical flags for OpenSTA.

Changes

Cohort / File(s)	Summary
Query section documentation expansion docs/syntax/README.md	Changed Query heading from top-level to a subheading and added multiple labeled subsections (get_ports, get_clocks, get_pins, get_cells, get_nets, all_inputs, all_outputs, all_clocks) with usage examples and a note about hierarchical flags for OpenSTA.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Single documentation file; no code or behavioral changes.
• Check for formatting consistency and correct examples in docs/syntax/README.md.

Possibly related PRs

• [Docs] Added Syntax Coverage Draft #21 — Related edits to docs/syntax/README.md Query subsections and usage examples.

Poem

🐰 I hopped through headings, tidy and bright,

Subsections planted, queries set right,
Ports and clocks in clear little rows,
Nets and pins lined up where everyone knows,
A happy rabbit cheers the doc’s new light. ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly matches the primary change: adding Query Commands documentation to SDC Syntax Docs.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature-docs

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b392981 and ad01bcf.

📒 Files selected for processing (1)

• docs/syntax/README.md (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-12-10T14:05:50.708Z

Learnt from: AlexandreSinger
Repo: siliconcompiler/fpga-timing-coverage-suite PR: 21
File: docs/syntax/README.md:7-7
Timestamp: 2025-12-10T14:05:50.708Z
Learning: In Markdown documentation files (e.g., docs/syntax/README.md), code blocks used to illustrate SDC syntax usage should be treated as non-executable examples. They are for formatting/readability and should not include language identifiers or syntax highlighting. Use plain code blocks without language tags to reflect that they are not actual SDC code.

Applied to files:

• docs/syntax/README.md

🪛 markdownlint-cli2 (0.18.1)

docs/syntax/README.md

155-155: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

164-164: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

173-173: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

182-182: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

193-193: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

204-204: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

210-210: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

216-216: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🔇 Additional comments (1)

docs/syntax/README.md (1)

151-218: Excellent fixes to previous issues; markdownlint warnings are false positives.

The documentation now correctly addresses the two critical issues from prior review feedback:

• Line 174: The get_pins code block now shows the correct command name (not copy-pasted from get_ports).
• Lines 189 and 200: Both instances of "heirarchical" have been corrected to "hierarchical".

The new Query section is well-structured with clear subsections for each command and consistent formatting across get_ports, get_clocks, get_pins, get_cells, and get_nets, plus the utility commands all_inputs, all_outputs, and all_clocks.

Regarding the markdownlint MD040 warnings about missing language specifiers on code blocks: Based on the learnings from PR 21, SDC syntax examples are intentionally presented as plain code blocks without language identifiers because they are non-executable examples for formatting/readability. This is the correct approach for this documentation.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 748f16d and b392981.

📒 Files selected for processing (1)

• docs/syntax/README.md (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-12-10T14:05:50.708Z

Learnt from: AlexandreSinger
Repo: siliconcompiler/fpga-timing-coverage-suite PR: 21
File: docs/syntax/README.md:7-7
Timestamp: 2025-12-10T14:05:50.708Z
Learning: In Markdown documentation files (e.g., docs/syntax/README.md), code blocks used to illustrate SDC syntax usage should be treated as non-executable examples. They are for formatting/readability and should not include language identifiers or syntax highlighting. Use plain code blocks without language tags to reflect that they are not actual SDC code.

Applied to files:

• docs/syntax/README.md

🪛 GitHub Actions: lint

docs/syntax/README.md

[error] 189-189: codespell: 'heirarchical' should be 'hierarchical'.

---

[error] 200-200: codespell: 'heirarchical' should be 'hierarchical'.

🪛 LanguageTool

docs/syntax/README.md

[grammar] ~189-~189: Ensure spelling is correct
Context: ...`` Note: OpenSTA has special flags for heirarchical matches. Should consider adding. ### g...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

---

[grammar] ~200-~200: Ensure spelling is correct
Context: ...`` Note: OpenSTA has special flags for heirarchical matches. Should consider adding. ### a...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🪛 markdownlint-cli2 (0.18.1)

docs/syntax/README.md

155-155: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

164-164: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

173-173: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

182-182: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

193-193: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

204-204: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

210-210: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

216-216: Fenced code blocks should have a language specified

(MD040, fenced-code-language)