DOC options must be a dict when used with extends_documentation_fragment (#21745)

* Fix string formatting
* Provide better tracebacks
* When options is None and extends_documentation_fragment is in use, add an error that options must be a dict
* If options was specified and not a dict, then error
This commit is contained in:
Matt Martz 2017-02-21 19:42:39 -06:00 committed by Matt Clay
parent 404b2864ef
commit b143fdea54
2 changed files with 13 additions and 5 deletions

View file

@ -117,7 +117,7 @@ def get_docstring(filename, verbose=False):
elif isinstance(doc[key], MutableSequence):
doc[key] = sorted(frozenset(doc[key] + value))
else:
raise Exception("Attempt to extend a documentation fragement (%s) of unknown type: %s" (fragment_name, filename))
raise Exception("Attempt to extend a documentation fragement (%s) of unknown type: %s" % (fragment_name, filename))
elif 'EXAMPLES' == theid:
plainexamples = child.value.s[1:] # Skip first empty line