Skip to content

[Feature Request]: Improve Python state docs #34905

@damccorm

Description

@damccorm

What would you like to happen?

It is unclear how to use some state from the pydoc. For example, searching for BagState yields BagStateSpec only: https://beam.apache.org/releases/pydoc/2.62.0/search.html?q=BagState&check_keywords=yes&area=default

We have more info here - https://beam.apache.org/documentation/programming-guide/#state-and-timers - but the actual pydocs are unclear. We should link to the programming guide from the pydoc for different state specs and StateDoFnParam

Issue Priority

Priority: 2 (default / most feature requests should be filed as P2)

Issue Components

  • Component: Python SDK
  • Component: Java SDK
  • Component: Go SDK
  • Component: Typescript SDK
  • Component: IO connector
  • Component: Beam YAML
  • Component: Beam examples
  • Component: Beam playground
  • Component: Beam katas
  • Component: Website
  • Component: Infrastructure
  • Component: Spark Runner
  • Component: Flink Runner
  • Component: Samza Runner
  • Component: Twister2 Runner
  • Component: Hazelcast Jet Runner
  • Component: Google Cloud Dataflow Runner

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions