41 lines
768 B
Plaintext
41 lines
768 B
Plaintext
{{! DocBlockr Docstring Template }}
|
|
{{=<% %>=}}
|
|
<%summaryPlaceholder%>
|
|
|
|
<%extendedSummaryPlaceholder%>
|
|
<%#argsExist%>
|
|
|
|
Arguments:
|
|
<%#args%>
|
|
<%var%> {<%typePlaceholder%>} -- <%descriptionPlaceholder%>
|
|
<%/args%>
|
|
<%/argsExist%>
|
|
<%#kwargsExist%>
|
|
|
|
Keyword Arguments:
|
|
<%#kwargs%>
|
|
<%var%> {<%typePlaceholder%>} -- <%descriptionPlaceholder%> (default: {<%&default%>})
|
|
<%/kwargs%>
|
|
<%/kwargsExist%>
|
|
<%#exceptionsExist%>
|
|
|
|
Raises:
|
|
<%#exceptions%>
|
|
<%type%>: <%descriptionPlaceholder%>
|
|
<%/exceptions%>
|
|
<%/exceptionsExist%>
|
|
<%#returnsExist%>
|
|
|
|
Returns:
|
|
<%#returns%>
|
|
<%typePlaceholder%> -- <%descriptionPlaceholder%>
|
|
<%/returns%>
|
|
<%/returnsExist%>
|
|
<%#yieldsExist%>
|
|
|
|
Yields:
|
|
<%#yields%>
|
|
<%typePlaceholder%> -- <%descriptionPlaceholder%>
|
|
<%/yields%>
|
|
<%/yieldsExist%>
|