Improve docstrings for design execution and candidate classes#1041
Closed
Improve docstrings for design execution and candidate classes#1041
Conversation
- DesignExecution: explain the execution lifecycle and link to Score, candidates(), and hierarchical_candidates() - candidates(): document return ordering (by score), per_page, and return type with full Parameters/Returns sections - hierarchical_candidates(): explain the difference from candidates() (includes process history and sub-materials) - predict(): document PredictRequest input and DesignCandidate return with full Parameters/Returns sections - PredictRequest: add full Parameters section documenting all 5 constructor arguments - DesignCandidate: explain primary_score semantics - DesignVariable: list all subtypes and when each is used - DesignCandidateComment: add missing class docstring Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Author
|
Consolidated into docs/improve-sdk-documentation branch. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
DesignExecution: explain lifecycle and link to Score/candidates methodscandidates(),hierarchical_candidates(),predict(): add full Parameters/Returns sections (these had NO docstrings beyond one line)PredictRequest: add full Parameters section for all 5 constructor arguments (previously undocumented)DesignCandidate: explainprimary_scoresemantics (higher = better)DesignVariable: list all 5 subtypes and when each is usedDesignCandidateComment: add missing class docstringTest plan
🤖 Generated with Claude Code
Docs PR 3 of 8 in the documentation improvement series.