summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2015-11-14 09:24:31 -0500
committerJason R. Coombs <jaraco@jaraco.com>2015-11-14 09:24:31 -0500
commit4283d066a5c46ec515ad017b3b172ba3c9ed4319 (patch)
treece43fcd95ccea9ba167df731245ba36103220a3a
parent0ac8221d70b6790ff1e35e757cc1a69efde91ebb (diff)
downloadsetuptools-scm-4283d066a5c46ec515ad017b3b172ba3c9ed4319.tar.gz
Transfer documentation from docstring to README. Fixes #64.
-rw-r--r--README.rst6
-rw-r--r--setuptools_scm/__init__.py2
2 files changed, 7 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index bd62020..63699e5 100644
--- a/README.rst
+++ b/README.rst
@@ -126,6 +126,12 @@ The Currently supported configuration keys are:
a newstyle format string thats given the current version as
the :code:`version` keyword argument for formatting
+:relative_to:
+ a file from which root may be resolved. typically called by a
+ script or module that is not
+ in the root of the repository to direct setuptools_scm to the
+ root of the repository by supplying ``__file__``.
+
To use setuptools_scm in other Python code you can use the
``get_version`` function:
diff --git a/setuptools_scm/__init__.py b/setuptools_scm/__init__.py
index 4507d86..0e03a7d 100644
--- a/setuptools_scm/__init__.py
+++ b/setuptools_scm/__init__.py
@@ -67,7 +67,7 @@ def get_version(root='.',
If supplied, relative_to should be a file from which root may
be resolved. Typically called by a script or module that is not
in the root of the repository to direct setuptools_scm to the
- root of the repository by passing ``__file__``.
+ root of the repository by supplying ``__file__``.
"""
if relative_to:
root = os.path.join(os.path.dirname(relative_to), root)