Skip to content

docs: correct StepResult field list in concepts guide - #811

Merged
burtenshaw merged 2 commits into
mainfrom
docs/fix-stepresult-fields-concepts
Jun 16, 2026
Merged

docs: correct StepResult field list in concepts guide#811
burtenshaw merged 2 commits into
mainfrom
docs/fix-stepresult-fields-concepts

Conversation

@sergiopaniego

Copy link
Copy Markdown
Member

Summary

The Core Concepts guide listed StepResult fields that don't exist on the dataclass (terminated, truncated, info). Update the list to match the real fields: observation, reward, done, and
metadata (the latter added in #805).

Type of Change

  • Documentation

Alignment Checklist

Before submitting, verify:

  • I have read .claude/docs/PRINCIPLES.md and this PR aligns with our principles
  • I have checked .claude/docs/INVARIANTS.md and no invariants are violated
  • I have run /pre-submit-pr (or bash .claude/hooks/lint.sh and tests) and addressed all issues

RFC Status

  • Not required (bug fix, docs, minor refactoring)

Test Plan

Docs-only change. Verify the StepResult bullet list in docs/source/guides/concepts.md matches the dataclass in src/openenv/core/client_types.py (observation, reward, done, metadata).

Claude Code Review

N/A

@sergiopaniego
sergiopaniego requested a review from burtenshaw June 16, 2026 10:09
@bot-ci-comment

Copy link
Copy Markdown

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants