diff --git a/src/docstring/get_template.ts b/src/docstring/get_template.ts index 373d280..8e29b33 100644 --- a/src/docstring/get_template.ts +++ b/src/docstring/get_template.ts @@ -1,11 +1,16 @@ + import {readFileSync} from "fs"; export function getTemplate(docstringFormat: string): string { switch (docstringFormat) { case "google": return getTemplateFile("google.mustache"); + case "google-simplified": + return getTemplateFile("google-simplified.mustache"); case "sphinx": return getTemplateFile("sphinx.mustache"); + case "sphinx-simplified": + return getTemplateFile("sphinx-simplified.mustache"); case "numpy": return getTemplateFile("numpy.mustache"); default: diff --git a/src/docstring/templates/google-simplified.mustache b/src/docstring/templates/google-simplified.mustache new file mode 100644 index 0000000..a0840a2 --- /dev/null +++ b/src/docstring/templates/google-simplified.mustache @@ -0,0 +1,29 @@ +{{! Google Docstring Template }} +{{summaryPlaceholder}} +{{#parametersExist}} +Args: +{{#args}} + {{var}} ({{typePlaceholder}}): {{descriptionPlaceholder}} +{{/args}} +{{#kwargs}} + {{var}} ({{typePlaceholder}}, optional): {{descriptionPlaceholder}}. Defaults to {{&default}}. +{{/kwargs}} +{{/parametersExist}} +{{#exceptionsExist}} +Raises: +{{#exceptions}} + {{type}}: {{descriptionPlaceholder}} +{{/exceptions}} +{{/exceptionsExist}} +{{#returnsExist}} +Returns: +{{#returns}} + {{typePlaceholder}}: {{descriptionPlaceholder}} +{{/returns}} +{{/returnsExist}} +{{#yieldsExist}} +Yields: +{{#yields}} + {{typePlaceholder}}: {{descriptionPlaceholder}} +{{/yields}} +{{/yieldsExist}} \ No newline at end of file diff --git a/src/docstring/templates/sphinx-simplified.mustache b/src/docstring/templates/sphinx-simplified.mustache new file mode 100644 index 0000000..a1f900e --- /dev/null +++ b/src/docstring/templates/sphinx-simplified.mustache @@ -0,0 +1,18 @@ +{{! Sphinx Docstring Template }} +{{summaryPlaceholder}} +{{#args}} +:param {{var}}: ({{typePlaceholder}}): {{descriptionPlaceholder}} +{{/args}} +{{#kwargs}} +:param {{var}}: ({{typePlaceholder}}, optional): {{descriptionPlaceholder}}, defaults to {{&default}} +{{/kwargs}} +{{#exceptions}} +:raises {{type}}: {{descriptionPlaceholder}} +{{/exceptions}} +{{#returns}} +:return: ({{typePlaceholder}}): {{descriptionPlaceholder}} +{{/returns}} + +{{#yields}} +:yield: ({{typePlaceholder}}): {{descriptionPlaceholder}} +{{/yields}} \ No newline at end of file