Adding docstrings to snippets (#13343)

Alan Ninan Thomas · brettcannon · web-flow · commit 7e3bb5df6f9a · 2020-08-17T13:11:12.000-07:00
* Added docstrings to snippets * added a news entry file * Sorry! I a typo * Revert "Sorry! I a typo" This reverts commit cbbff6a. * Revert "added a news entry file" This reverts commit 6edf889. * Revert "Added docstrings to snippets" This reverts commit 3bdcdd1. * Hopefully, it fixed the whitespace issues * Update snippets/python.json Co-authored-by: Brett Cannon <brett@python.org> Co-authored-by: Brett Cannon <brett@python.org>
diff --git a/news/1 Enhancements/5578.md b/news/1 Enhancements/5578.md
@@ -0,0 +1 @@
+Docstrings are added to `class` and `def` snippets (thanks [alannt777](https://github.com/alannt777/))
diff --git a/snippets/python.json b/snippets/python.json
@@ -94,27 +94,27 @@
     },
     "def": {
         "prefix": "def",
-        "body": ["def ${1:funcname}(${2:parameter_list}):", "\t${3:pass}"],
+        "body": ["def ${1:funcname}(${2:parameter_list}):", "\t\"\"\"", "\t${3:docstring}", "\t\"\"\"","\t${4:pass}"],
         "description": "Code snippet for a function definition"
     },
     "def(class method)": {
         "prefix": "def(class method)",
-        "body": ["def ${1:funcname}(self, ${2:parameter_list}):", "\t${3:pass}"],
+        "body": ["def ${1:funcname}(self, ${2:parameter_list}):", "\t\"\"\"", "\t${3:docstring}", "\t\"\"\"", "\t${4:pass}"],
         "description": "Code snippet for a class method"
     },
     "def(static class method)": {
         "prefix": "def(static class method)",
-        "body": ["@staticmethod", "def ${1:funcname}(${2:parameter_list}):", "\t${3:pass}"],
+        "body": ["@staticmethod", "def ${1:funcname}(${2:parameter_list}):", "\t\"\"\"", "\t${3:docstring}", "\t\"\"\"", "\t${4:pass}"],
         "description": "Code snippet for a static class method"
     },
     "def(abstract class method)": {
         "prefix": "def(abstract class method)",
-        "body": ["def ${1:funcname}(self, ${2:parameter_list}):", "\traise NotImplementedError"],
+        "body": ["def ${1:funcname}(self, ${2:parameter_list}):", "\t\"\"\"", "\t${3:docstring}", "\t\"\"\"", "\traise NotImplementedError"],
         "description": "Code snippet for an abstract class method"
     },
     "class": {
         "prefix": "class",
-        "body": ["class ${1:classname}(${2:object}):", "\t${3:pass}"],
+        "body": ["class ${1:classname}(${2:object}):", "\t\"\"\"", "\t${3:docstring}", "\t\"\"\"", "\t${4:pass}"],
         "description": "Code snippet for a class definition"
     },
     "lambda": {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Docstrings are added to `class` and `def` snippets (thanks [alannt777](https://github.com/alannt777/))