add docstring mustache

ocadotechnology · Mar 4, 2024 · 6292fc9 · 6292fc9
1 parent 75b5fcb
commit 6292fc9
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 2 deletions.
diff --git a/.vscode/extensions/autoDocstring/docstring.mustache b/.vscode/extensions/autoDocstring/docstring.mustache
@@ -0,0 +1,35 @@
+{{! Based off of: https://github.com/NilsJPWerner/autoDocstring/blob/master/src/docstring/templates/google-notypes.mustache }}
+{{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}}
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -31,8 +31,8 @@
       ],
       "django": true,
       "env": {
-        "SERVICE_NAME": "portal",
-        "SERVICE_IS_ROOT": "1"
+        "SERVICE_IS_ROOT": "1",
+        "SERVICE_NAME": "portal"
       },
       "justMyCode": false,
       "name": "Django Server",