Permalink
Browse files

better function comment

  • Loading branch information...
1 parent fc0fe65 commit 2b2ca7c6ea98c41d94eae2595cfdbd2700c54ba2 @timf timf committed Mar 10, 2011
Showing with 4 additions and 2 deletions.
  1. +4 −2 cloudinitd/persistence.py
@@ -81,14 +81,16 @@ def config_get_or_none(parser, s, v, default=None):
def _resolve_file_or_none(context_dir, conf, conf_file):
"""Return absolute path to file if specified. If None or empty string return None.
- Supports configurations of "../xyz" being taken relative to the configuration file it
- was specified in.
+ Supports configurations of "../xyz" (or "xyz") being taken relative to the configuration
+ file it was specified in.
* context_dir - Directory of the configuration file (level*conf)
* conf - Configuration value, may be None or empty string
* conf_file - Absolute path to the file where the configuration was (for errors)
+
+ If there is a path to be resolved, Exception is raised when it does not exist.
"""
if not conf:
return None

0 comments on commit 2b2ca7c

Please sign in to comment.