summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2013-03-30 12:33:31 +0100
committerGeorg Brandl <georg@python.org>2013-03-30 12:33:31 +0100
commitae401ab6db5b8bd26a18ed1fd1198cc2ee71cd5b (patch)
tree7c228b74248380815875953e795df8eaa3644504
parent9616d987850b2400a36f45e9f8e2090da99ad069 (diff)
downloadsphinx-ae401ab6db5b8bd26a18ed1fd1198cc2ee71cd5b.tar.gz
environment: clarify docstring
-rw-r--r--sphinx/environment.py5
1 files changed, 3 insertions, 2 deletions
diff --git a/sphinx/environment.py b/sphinx/environment.py
index e7e03024..5c1947c7 100644
--- a/sphinx/environment.py
+++ b/sphinx/environment.py
@@ -309,8 +309,9 @@ class BuildEnvironment:
"""Return paths to a file referenced from a document, relative to
documentation root and absolute.
- Absolute filenames are relative to the source dir, while relative
- filenames are relative to the dir of the containing document.
+ In the input "filename", absolute filenames are taken as relative to the
+ source dir, while relative filenames are relative to the dir of the
+ containing document.
"""
if filename.startswith('/') or filename.startswith(os.sep):
rel_fn = filename[1:]