[Docs] Added Syntax Coverage Draft

[AlexandreSinger]

Added documentation which describes the set of SDC syntax we are hoping to support for this test suite.

This is a first draft and is subject to review.

Summary by CodeRabbit

• Documentation
  • Added comprehensive guide covering SDC syntax, including timing-constraint commands (clock creation, false paths, delays, uncertainty) and query operations with detailed option flags and usage examples.

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

[coderabbitai]

Walkthrough

Adds comprehensive SDC (Synopsys Design Constraints) syntax documentation to docs/syntax/README.md. Covers timing-constraint commands including clock creation, delay specifications, path constraints, clock groups, and query functions with their respective option flags and usage patterns.

Changes

Cohort / File(s)	Summary
SDC Syntax Documentation docs/syntax/README.md	Introduces detailed SDC command reference covering create_clock, create_generated_clock, set_clock_groups, set_false_path, set_max_delay, set_min_delay, set_multicycle_path, set_input_delay, set_output_delay, set_clock_uncertainty, set_clock_latency, set_disable_timing, and query commands for ports, clocks, pins, cells, nets, and clock/input/output lists

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Documentation content review for completeness and accuracy of SDC command syntax
• Verification of option flags and parameter descriptions

Poem

🐰 A syntax guide hops into place,
With clocks and constraints interlace,
From create to query, each command so bright,
Documentation makes timing right! ✨

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 '[Docs] Added Syntax Coverage Draft' accurately describes the main change: documentation addition for SDC syntax coverage. It is specific and clearly related to the changeset.
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

---

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: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8d43039 and 3f9df22.

📒 Files selected for processing (1)

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

🧰 Additional context used

🪛 LanguageTool

docs/syntax/README.md

[style] ~40-~40: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal).
Context: ... flag called "-exclusive". Should check if we want this or not. ### set_false_pat...

(IF_WHETHER)

🪛 markdownlint-cli2 (0.18.1)

docs/syntax/README.md

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

(MD040, fenced-code-language)

---

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

(MD040, fenced-code-language)

---

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

(MD040, fenced-code-language)

---

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

(MD040, fenced-code-language)

---

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

(MD040, fenced-code-language)

---

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

(MD040, fenced-code-language)

---

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

(MD040, fenced-code-language)

---

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

(MD040, fenced-code-language)

---

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

(MD040, fenced-code-language)

---

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

(MD040, fenced-code-language)

---

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

(MD040, fenced-code-language)

---

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

(MD040, fenced-code-language)

🔇 Additional comments (1)

docs/syntax/README.md (1)

27-27: Clarify pending decisions in documentation notes.

Lines 27, 40, 54, and 141 contain notes deferring decisions about command options (e.g., "Should confirm if we want to support them", "Should check if we want this or not"). Since this is documented as a first draft, clarify whether these are:

• Acceptable TODOs for a draft document pending team consensus
• Blocking items requiring resolution before merge
• Tracked in a separate issue or discussion

Additionally, line 40 could be reworded for formality: replace "Should check if we want" with "Should check whether we want" for more formal context.

Also applies to: 40-40, 54-54, 141-141