Skip to content
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

Documentation for local #276

Closed
davidedelvento opened this issue May 2, 2016 · 3 comments
Closed

Documentation for local #276

davidedelvento opened this issue May 2, 2016 · 3 comments

Comments

@davidedelvento
Copy link
Contributor

It looks like there is no API doc for local(), the one it's imported with from plumbum import local since from http://plumbum.readthedocs.io/en/latest/index.html#api-reference only subpackages are documented and not the plumbum package itself.

@henryiii
Copy link
Collaborator

It's actually an instance of a plumbum.machines.local.LocalMachine, so it is documented there.

@henryiii
Copy link
Collaborator

Let me know if you think a note similar to that in the docs somewhere would be helpful.

@davidedelvento
Copy link
Contributor Author

Yes, I think a note about that in the docs would be very useful. Thanks

henryiii added a commit that referenced this issue Jun 12, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants