@@ -5,3 +5,103 @@ A Python wrapper for the Glasses3 API
55## Dev Notes
66To get more DEBUG logs from asyncio, set the environment variable PYTHONDEVMODE:
77``` $env:PYTHONDEVMODE = 1 ```
8+
9+ ## Docstrings
10+
11+ Docstrings is used to document code according to the following template:
12+ ``` python
13+ """ Module summary
14+
15+ More in-depth information of the module. This docstring is placed at the top of the file, over the imports.
16+ """
17+ import asyncio
18+
19+ def my_simple_function (arg_1 : str , arg_2 : int ):
20+ """ Summary of my_simple_function.
21+
22+ Takes in a name and number.
23+
24+ Returns a pair of glasses.
25+
26+ """
27+ pass
28+
29+ def my_long_function (arg_1 : str , arg_2 : int ):
30+ """ Summary of my_simple_function.
31+
32+ ###### Args
33+ - `arg_1`: The first argument.
34+ - `arg_2`: The second argument.
35+
36+ ###### Returns
37+ Something you want to use.
38+
39+ ###### Raises
40+ - `MyError`: An error indicating some error.
41+ """
42+ pass
43+
44+
45+ class MyClass :
46+ """ Summary of MyClass, max 80 characters long.
47+
48+ Some more in-depth information about MyClass.
49+ """
50+
51+ variable_1: str
52+ """ The first variable"""
53+
54+ variable_2: int
55+ """ The second variable"""
56+
57+ def __init__ (arg_1 : str ):
58+ """ Initializes object, where arg_1 is your `variable_1`."""
59+ self .variable_1 = arg_1
60+
61+ def my_simple_method (arg_1 : str , arg_2 : int ):
62+ """ Summary of my_simple_method.
63+
64+ Takes in a name and number.
65+
66+ Returns something simple.
67+ """
68+ pass
69+
70+ def my_long_method (arg_1 : str , arg_2 : int ):
71+ """
72+ Summary of my_long_method.
73+
74+ Some more in-depth information about my_long_method.
75+
76+ ###### Args
77+ - `arg_1`: The first argument.
78+ - `arg_2`: The second argument.
79+
80+ ###### Returns
81+ Something you want to use.
82+
83+ ###### Raises
84+ - `MyError`: An error indicating some error.
85+ """
86+ pass
87+
88+ class MyAdvancedClass :
89+ """ Summary of MyAdvancedClass, max 80 characters long.
90+
91+ Some more in-depth information about MyClass.
92+ """
93+
94+ def __init__ (arg_1 : str , arg_2 : int ):
95+ """ Initializes object.
96+
97+ ###### Args
98+ - `arg_1`: The first argument.
99+ - `arg_2`: The second argument.
100+
101+ ###### Raises
102+ - `MyError`: An error indicating some error.
103+
104+ """
105+ pass
106+
107+ ```
0 commit comments