fix: format docs/design

[cpaniaguam]

Summary by CodeRabbit

• Chores

  • Updated the Ruff lint configuration to ignore the PLR0917 (“Too many positional arguments”) rule.

• Documentation

  • Refreshed the HSSM-HMM design documentation by reformatting embedded examples, type-hint snippets, and API call signatures for clearer, consistent usage.
  • Tweaked the HSSM-HMM overview v1 snippet formatting (whitespace/alignment) without changing the workflow.

[coderabbitai]

📝 Walkthrough

Walkthrough

Ruff now ignores PLR0917. HSSM-HMM design documentation examples, imports, signatures, type annotations, and assignments are reformatted without changing documented APIs or workflows.

Changes

Lint and HSSM-HMM documentation updates

Layer / File(s)	Summary
Ruff rule configuration pyproject.toml	Adds PLR0917 to Ruff’s ignored rules.
HSSM-HMM documentation formatting docs/design/hssm_hmm.md, docs/design/hssm_hmm_overview.md	Reflows code examples, imports, signatures, annotations, and assignments without semantic changes.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: krishnbera, fmuia

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Title check	✅ Passed	The title is concise and refers to the documentation formatting changes included in the PR, though it doesn't mention the lint config change.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch ignore-docs-in-linting-workflow

---

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

[digicosmos86]

Thanks @cpaniaguam! I think we should keep the docs folder - the tutorials need to be linted

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@pyproject.toml`:
- Around line 179-180: Remove PLR0917 from the global tool.ruff.lint ignore list
and configure it as a path-scoped exemption applying only to documentation
files, while preserving the existing docs exclusion and ensuring production and
test code remains checked.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d4f6cd80-75f0-46a5-af4c-0c994ddbef80

📥 Commits

Reviewing files that changed from the base of the PR and between 9a81141 and c37fd2b.

📒 Files selected for processing (3)

• docs/design/hssm_hmm.md
• docs/design/hssm_hmm_overview.md
• pyproject.toml

[digicosmos86]

LGTM!