From 90b440769bf6412530b2b11d5b19517959477f4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= <40836345+signekb@users.noreply.github.com> Date: Mon, 2 Sep 2024 15:37:21 +0200 Subject: [PATCH] fix: update google-notypes.mustache Following the Google style guide examples, this moves the Raises section below the Returns section and adds `.` after placeholders --- .../templates/google-notypes.mustache | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/src/docstring/templates/google-notypes.mustache b/src/docstring/templates/google-notypes.mustache index 38442f0..a678383 100644 --- a/src/docstring/templates/google-notypes.mustache +++ b/src/docstring/templates/google-notypes.mustache @@ -1,35 +1,35 @@ {{! Google Docstring Template without Types for Args, Returns or Yields }} -{{summaryPlaceholder}} +{{summaryPlaceholder}}. {{extendedSummaryPlaceholder}} {{#parametersExist}} Args: {{#args}} - {{var}}: {{descriptionPlaceholder}} + {{var}}: {{descriptionPlaceholder}}. {{/args}} {{#kwargs}} {{var}}: {{descriptionPlaceholder}}. Defaults to {{&default}}. {{/kwargs}} {{/parametersExist}} -{{#exceptionsExist}} - -Raises: -{{#exceptions}} - {{type}}: {{descriptionPlaceholder}} -{{/exceptions}} -{{/exceptionsExist}} {{#returnsExist}} Returns: {{#returns}} - {{descriptionPlaceholder}} + {{descriptionPlaceholder}}. {{/returns}} {{/returnsExist}} +{{#exceptionsExist}} + +Raises: +{{#exceptions}} + {{type}}: {{descriptionPlaceholder}}. +{{/exceptions}} +{{/exceptionsExist}} {{#yieldsExist}} Yields: {{#yields}} - {{descriptionPlaceholder}} + {{descriptionPlaceholder}}. {{/yields}} {{/yieldsExist}}