Skip to content

Improve pyscript documentation #644

@kmvanbrunt

Description

@kmvanbrunt

The section in Sphinx on pyscript command needs a bit of updating.
Topics to cover:

  • Running commands with app()
  • Developing a basic scripting API that only relies on stdout and stderr in CommandResult
  • Developing an advanced scripting API that includes populating cmd2.last_result which becomes CommandResult.data
  • Utilizing StdSim.pause_storage to avoid duplicating data already stored in CommandResult.data
  • Processing a CommandResult object returned from app()
  • Exposing custom data values with self.py_locals.

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions