Skip to content

/ cmd2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve pyscript documentation #644

Open
kmvanbrunt opened this issue Mar 10, 2019 · 4 comments
Open

Improve pyscript documentation #644

kmvanbrunt opened this issue Mar 10, 2019 · 4 comments
Assignees
@kmvanbrunt
Labels
documentation major

Comments

@kmvanbrunt
Copy link
Member

@kmvanbrunt kmvanbrunt commented Mar 10, 2019

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()
@kmvanbrunt kmvanbrunt added this to the 1.0.0 milestone Mar 10, 2019
@tleonhardt
Copy link
Member

@tleonhardt tleonhardt commented Mar 23, 2019

Given the power of pyscript, our documentation has been sorely lacking in helping making this discoverable to end users
@tleonhardt tleonhardt added the major label Mar 23, 2019
@tleonhardt tleonhardt mentioned this issue Nov 23, 2019
Merged
@tleonhardt tleonhardt mentioned this issue Feb 29, 2020
Closed
@kotfu
Copy link
Member

@kotfu kotfu commented Feb 29, 2020

We have some basic pyscript documentation now. I propose we move this issue out of the 1.0.0 milestone so that we can release. Any objections?
@tleonhardt
Copy link
Member

@tleonhardt tleonhardt commented Feb 29, 2020

@kotfu Sure moving this issue out of 1.0.0 sounds fine. We really could benefit from some improved pyscript documentation at some point, but it can happen after the 1.0 release.

@kmvanbrunt Do you have any pyscript documentation that you have been working on?
@kotfu kotfu mentioned this issue Feb 29, 2020
Merged
@tleonhardt tleonhardt removed this from the 1.0.0 milestone Feb 29, 2020
anselor added a commit that referenced this issue Jun 16, 2020
@anselor
Further additions to pyscript documenntation for Issue #644
Loading status checks…
dbcef03
anselor added a commit that referenced this issue Jun 22, 2020
@anselor
Further additions to pyscript documenntation for Issue #644
87aeaf4
tleonhardt added a commit that referenced this issue Jul 3, 2020
@tleonhardt
Merge pull request #947 from python-cmd2/pyscript_docs
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
96c8144 
Further additions to pyscript documenntation for Issue #644
@anselor
Copy link
Contributor

@anselor anselor commented Aug 4, 2020

It's probably also worth nothing that the external test plugin simply opens up the pyscript as a cmd2 member function to make it easier to unit test cmd2 application commands.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kmvanbrunt kmvanbrunt

Labels
documentation major
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
@kotfu @tleonhardt @anselor @kmvanbrunt
You can’t perform that action at this time.