Skip to content

Add docstring examples to rocky-sdk RockyClient core methods #898

Description

@hugocorreia90

rocky-sdk is published on PyPI, but sdk/python/src/rocky_sdk/client.py has zero worked examples in its docstrings across the ~20 public RockyClient methods. New users discovering the SDK have to read the source to learn how to construct a client and call it. #482 added Example: blocks to the Dagster health helpers; this is the same shape on the canonical, more-used surface.

Scope (capped — do not document all 20 methods)

Add a Sphinx-style Example: block to the four core methods only:

  1. RockyClient.discoverengine/crates/.../client.pysdk/python/src/rocky_sdk/client.py:666
  2. RockyClient.plansdk/python/src/rocky_sdk/client.py:687
  3. RockyClient.applysdk/python/src/rocky_sdk/client.py:709
  4. RockyClient.runsdk/python/src/rocky_sdk/client.py:721

Each example should show constructing RockyClient(...) and using the returned typed model. Pure docstring work — no logic or signature changes.

Code refs

Acceptance criteria

  • Each of the four methods gains an Example: block with runnable example code
  • Examples import RockyClient from rocky_sdk (the public path)
  • ruff check sdk/python is clean
  • pytest sdk/python is green (no regressions)

Effort

2 hours.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions