From ae401ab6db5b8bd26a18ed1fd1198cc2ee71cd5b Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sat, 30 Mar 2013 12:33:31 +0100 Subject: environment: clarify docstring --- sphinx/environment.py | 5 +++-- 1 file 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:] -- cgit v1.2.1