docs: complete public API docstrings with examples (RM-337)

[rmems]

REPL help and generated docs now include Arguments, Returns, and a usage example for every exported SparseBrain / EnsembleBrain entry point, plus the reference LSM helpers.

Ensemble aggregation weights [0.4, 0.3, 0.2, 0.1] (Fast → Integrator) are documented on the type and constructor. _init_ref_lsm! states when to call it manually versus relying on lazy first-step init. Examples assume a CUDA device.

Closes #20
RM-337: https://linear.app/rpd-34/issue/RM-337

Validation

julia --project -e 'using Pkg; Pkg.test()' on this Cloud VM (no CUDA): 23 passed, 1 skipped (GPU). @doc SparseBrain / @doc step! / @doc LiquidCortex.run_lsm_step show Arguments, Returns, and Examples. Docs-only; no runtime behavior change.

  

---

Summary by cubic

Completes public API docstrings for SparseBrain / EnsembleBrain and the reference LSM helpers so REPL help and generated docs now include Arguments, Returns, and usage examples. Docs-only; no runtime behavior changes. Closes #20 (RM-337: https://linear.app/rpd-34/issue/RM-337).

Documented details worth noting

• Ensemble aggregation weights [0.4, 0.3, 0.2, 0.1] (Fast → Integrator) are now documented on the type and constructor.
• _init_ref_lsm! now states when to call it manually versus relying on lazy first-step init.
• Plasticity modes are backtick-escaped so they render as identifiers in generated docs.
• All examples assume a CUDA device.

^{Written for commit 047257d. Summary will update on new commits.}

[linear-code]

RM-337

[amazon-q-developer]

This PR successfully completes public API docstrings with proper structure and examples. All functions now include Arguments, Keyword Arguments, Returns, and Examples sections following Julia documentation conventions. No runtime behavior changes - documentation only.

---

You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.

[coderabbitai]

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

• Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

---

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

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!