Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions embodichain/lab/sim/skills/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,27 +38,37 @@
UnsupportedSkillError,
)
from .scene import (
AmbiguousSceneAffordanceError,
GRASP_AFFORDANCE_CAPABILITY,
PLACE_IN_AFFORDANCE_CAPABILITY,
PLACE_ON_AFFORDANCE_CAPABILITY,
RegistrySceneProvider,
SceneAffordanceRef,
SceneArticulationRef,
SceneCollisionRole,
SceneCollisionWorldMode,
SceneDynamics,
SceneEntityRef,
SceneEntityMetadata,
Comment on lines +41 to +52

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Public affordance API lacks documentation

The package now publicly exports the affordance capability constants, resolution exceptions, and SceneEntityMetadata, but this PR adds no user-facing documentation for their construction and validation contracts, making the new API harder to adopt correctly.

Context Used: AGENTS.md (source)

Prompt To Fix With AI
This is a comment left during a code review.
Path: embodichain/lab/sim/skills/__init__.py
Line: 41-52

Comment:
**Public affordance API lacks documentation**

The package now publicly exports the affordance capability constants, resolution exceptions, and `SceneEntityMetadata`, but this PR adds no user-facing documentation for their construction and validation contracts, making the new API harder to adopt correctly.

**Context Used:** AGENTS.md ([source](https://github.com/dexforce/embodichain/blob/main/AGENTS.md))

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Fix in Codex Fix in Claude Code

SceneEntityRegistration,
SceneEntityStateProvider,
SceneGeometryProvider,
SceneLinkRef,
SceneObjectRef,
SceneRegistry,
UnsupportedSceneAffordanceError,
)

__all__ = [
"AmbiguousSceneAffordanceError",
"AmbiguousSkillBindingError",
"BoundRobotSkillProfile",
"ControlPartEndpoint",
"ControlPartEndpointAdapter",
"EndpointResolution",
"GRASP_AFFORDANCE_CAPABILITY",
"PLACE_IN_AFFORDANCE_CAPABILITY",
"PLACE_ON_AFFORDANCE_CAPABILITY",
"ProfileValidationError",
"RegistrySceneProvider",
"ResolvedRobotResource",
Expand All @@ -76,6 +86,7 @@
"SceneCollisionWorldMode",
"SceneDynamics",
"SceneEntityRef",
"SceneEntityMetadata",
"SceneEntityRegistration",
"SceneEntityStateProvider",
"SceneGeometryProvider",
Expand All @@ -84,4 +95,5 @@
"SceneRegistry",
"SkillPolicyPreset",
"UnsupportedSkillError",
"UnsupportedSceneAffordanceError",
]
Loading