Skip to content

Session API: Documentation Improvements #2349

Description

@aaroncameron-wk

See parent issue for detail/context.

Documentation improvements (non-breaking, no code changes)

  • Document Session.run() parameters in the narrative docs
  • Document RuntimeOptions log fields
  • Document the relationship between get_logs(), get_log_messages(), and handler choice
  • Document log lifecycle across multiple run() calls
  • Improve Session.run() docstring for autodoc

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    Status
    Triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions