|
1 | 1 | { |
2 | 2 | "comment": { |
3 | | -"prefix":"\"\"\"", |
| 3 | +"prefix":"###", |
4 | 4 | "body": [ |
5 | 5 | "\"\"\"", |
6 | 6 | "${1:A one-line summary.}", |
|
21 | 21 | "description":"A Python docstring for functions and methods, including short summary, details, args, returns, and examples. This docstring is an synonym of\"\"\"function." |
22 | 22 | }, |
23 | 23 | "comment simple": { |
24 | | -"prefix":"\"\"", |
| 24 | +"prefix":"##", |
25 | 25 | "body": [ |
26 | 26 | "\"\"\"", |
27 | 27 | "${1:A one-line summary.}", |
|
32 | 32 | "description":"A simple Python docstring comment. Useful when you prefer to add the docstrings manually on functions." |
33 | 33 | }, |
34 | 34 | "module docstring": { |
35 | | -"prefix":"\"\"\"module", |
| 35 | +"prefix":"###module", |
36 | 36 | "body": [ |
37 | 37 | "\"\"\"", |
38 | 38 | "${1:A one-line summary.}", |
|
47 | 47 | "description":"A Python docstring for modules, including a one-line summary, details, and example." |
48 | 48 | }, |
49 | 49 | "test module docstring": { |
50 | | -"prefix":"\"\"\"test", |
| 50 | +"prefix":"###test", |
51 | 51 | "body": [ |
52 | 52 | "\"\"\"", |
53 | 53 | "${1:A one-line summary.}", |
|
58 | 58 | "description":"Module-level docstrings for test files are not required. They should be included only when there is additional information that can be provided.\n\nExamples include some specifics on how the test should be run, an explanation of an unusual setup pattern, dependency on the external environment, and so on. Docstrings that do not provide any new information should not be used, such as\"\"\"Tests for foo.bar.\"\"\"" |
59 | 59 | }, |
60 | 60 | "function docstring": { |
61 | | -"prefix":"\"\"\"function", |
| 61 | +"prefix":"###function", |
62 | 62 | "body": [ |
63 | 63 | "\"\"\"", |
64 | 64 | "${1:A one-line summary.}", |
|
79 | 79 | "description":"A Python docstring for functions and methods, including short summary, details, args, returns, and example." |
80 | 80 | }, |
81 | 81 | "function docstring typed": { |
82 | | -"prefix":"\"\"\"function_typed", |
| 82 | +"prefix":"###function_typed", |
83 | 83 | "body": [ |
84 | 84 | "\"\"\"", |
85 | 85 | "${1:A one-line summary.}", |
|
100 | 100 | "description":"Alternative Python docstring for functions and methods, with a different type syntax. Some teams prefer it." |
101 | 101 | }, |
102 | 102 | "generator docstring": { |
103 | | -"prefix":"\"\"\"generator", |
| 103 | +"prefix":"###generator", |
104 | 104 | "body": [ |
105 | 105 | "\"\"\"", |
106 | 106 | "${1:A one-line summary.}", |
|
121 | 121 | "description":"A Python docstring for generator methods, including a one-line summary, details, parameters, yields, and example. It is the same, but it has yields instead of returns." |
122 | 122 | }, |
123 | 123 | "class docstring": { |
124 | | -"prefix":"\"\"\"class", |
| 124 | +"prefix":"###class", |
125 | 125 | "body": [ |
126 | 126 | "\"\"\"", |
127 | 127 | "${1:A one-line summary.}", |
|
135 | 135 | "description":"A Python docstring for classes, including a one-line summary, details, attributes, and returns." |
136 | 136 | }, |
137 | 137 | "exception docstring": { |
138 | | -"prefix":"\"\"\"exception", |
| 138 | +"prefix":"###exception", |
139 | 139 | "body": [ |
140 | 140 | "\"\"\"", |
141 | 141 | "${1:A one-line summary.}", |
|
149 | 149 | "description":"A Python docstring for exceptions, including a one-line summary, description, and attributes." |
150 | 150 | }, |
151 | 151 | "raises docstring": { |
152 | | -"prefix":"\n\n\nraises", |
| 152 | +"prefix":"###raises", |
153 | 153 | "body": [ |
154 | 154 | "Raises:", |
155 | 155 | " ${1:ErrorName}: ${2:Error description.}$0" |
|