From 9a6dd4fb758db9a37911203a0a4fc317bc5dc09e Mon Sep 17 00:00:00 2001 From: Steven Willis Date: Fri, 17 Apr 2015 15:56:45 -0400 Subject: [PATCH] More documentation --- README.rst | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 65 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 0478874..e7f288c 100644 --- a/README.rst +++ b/README.rst @@ -8,8 +8,71 @@ System Git Utility to call git from python. Examples:: - >>> from sysgit import git - >>> git('ls-files') + >>> from sysgit import * + >>> res = git('ls-files') + .editorconfig + .gitignore + AUTHORS.rst + CONTRIBUTING.rst + HISTORY.rst + LICENSE + MANIFEST.in + README.rst + docs/Makefile + docs/authors.rst + docs/conf.py + docs/contributing.rst + docs/history.rst + docs/index.rst + docs/installation.rst + docs/make.bat + docs/readme.rst + docs/usage.rst + requirements.txt + setup.cfg + setup.py + sysgit/__init__.py + tox.ini + >>> print res + 0 + >>> res = git('ls-files', f=CHECK_OUTPUT) + >>> print res + .editorconfig + .gitignore + AUTHORS.rst + CONTRIBUTING.rst + HISTORY.rst + LICENSE + MANIFEST.in + README.rst + docs/Makefile + docs/authors.rst + docs/conf.py + docs/contributing.rst + docs/history.rst + docs/index.rst + docs/installation.rst + docs/make.bat + docs/readme.rst + docs/usage.rst + requirements.txt + setup.cfg + setup.py + sysgit/__init__.py + tox.ini + + >>> res = git('blah', f=CHECK_OUTPUT) + git: 'blah' is not a git command. See 'git --help'. + + Did you mean this? + blame + Traceback (most recent call last): + File "", line 1, in + File "sysgit/__init__.py", line 79, in git + return f(full_args, **full_kwargs) + File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/subprocess.py", line 573, in check_output + raise CalledProcessError(retcode, cmd, output=output) + subprocess.CalledProcessError: Command '('git', 'blah')' returned non-zero exit status 1 * Free software: BSD license * Documentation: https://pysysgit.readthedocs.org.