From 5ad7e585c65c3a25f37cf5eea14f3b816eba170a Mon Sep 17 00:00:00 2001 From: Semir Vrana Date: Wed, 16 Mar 2022 11:20:56 +0100 Subject: [PATCH] Add template google-notypes-nodefault --- package.json | 1 + .../google-notypes-nodefault.mustache | 35 +++++++++++++++++++ 2 files changed, 36 insertions(+) create mode 100644 src/docstring/templates/google-notypes-nodefault.mustache diff --git a/package.json b/package.json index 91d95e9..471e95b 100644 --- a/package.json +++ b/package.json @@ -78,6 +78,7 @@ "pep257", "google", "google-notypes", + "google-notypes-nodefault", "sphinx", "sphinx-notypes", "numpy", diff --git a/src/docstring/templates/google-notypes-nodefault.mustache b/src/docstring/templates/google-notypes-nodefault.mustache new file mode 100644 index 0000000..0ef29cb --- /dev/null +++ b/src/docstring/templates/google-notypes-nodefault.mustache @@ -0,0 +1,35 @@ +{{! Google Docstring Template without Types for Args, Returns or Yields and without naming the default for kwargs}} +{{summaryPlaceholder}} + +{{extendedSummaryPlaceholder}} +{{#parametersExist}} + +Args: +{{#args}} + {{var}}: {{descriptionPlaceholder}} +{{/args}} +{{#kwargs}} + {{var}}: {{descriptionPlaceholder}} +{{/kwargs}} +{{/parametersExist}} +{{#exceptionsExist}} + +Raises: +{{#exceptions}} + {{type}}: {{descriptionPlaceholder}} +{{/exceptions}} +{{/exceptionsExist}} +{{#returnsExist}} + +Returns: +{{#returns}} + {{descriptionPlaceholder}} +{{/returns}} +{{/returnsExist}} +{{#yieldsExist}} + +Yields: +{{#yields}} + {{descriptionPlaceholder}} +{{/yields}} +{{/yieldsExist}}