@@ -19,39 +19,39 @@ Listed is a example class used demonstrate general rules you should follow throu
1919
2020``` python
2121class ExampleClass :
22- """
23- ExampleClass
24- ------------
25- Example class for CODESTYLE.md
26- """
27- # ^^^ reST Docstring Format
28- 29- _private_attribute : int # private attributes begin with a lowercase
30- public_attribute : int # type hint for integer is defined here
31- 32- def __init__ (
33- self
34- public_attribute : int # type hint for parameters
35- ) -> None : # the expected return value of method
3622 """
37- Initializes a ExampleClass
38-
39- Parameters
40- ----------
41- :param public_attribute: example attribute
42- """
43- self .public_attribute = public_attribute
44- self .private_attribute = square(public_attribute)
45- 46- def square (self value : int ) -> int :
47- """
48- Example method that square roots a value
49-
50- Parameters
51- ----------
52- :param value: value that you want squared
23+ ExampleClass
24+ ------------
25+ Example class for CODESTYLE.md
5326 """
54- return value** 2
27+ # ^^^ reST Docstring Format
28+ 29+ _private_attribute : int # private attributes begin with a lowercase
30+ public_attribute : int # type hint for integer is defined here
31+ 32+ def __init__ (
33+ self
34+ public_attribute : int # type hint for parameters
35+ ) -> None : # the expected return value of method
36+ """
37+ Initializes a ExampleClass
38+
39+ Parameters
40+ ----------
41+ :param public_attribute: example attribute
42+ """
43+ self .public_attribute = public_attribute
44+ self .private_attribute = square(public_attribute)
45+ 46+ def square (self value : int ) -> int :
47+ """
48+ Example method that square roots a value
49+
50+ Parameters
51+ ----------
52+ :param value: value that you want squared
53+ """
54+ return value** 2
5555```
5656
5757
@@ -87,7 +87,7 @@ Currently, documentation for this project resides in markdown files.
8787 - Use of HTML is permitted
8888 - [ reference style links] ( https://www.markdownguide.org/basic-syntax/#reference-style-links ) are not required by are appreciated
8989 - Exceedingly long lines are to be broken
90- - The indents are to be two spaces
90+ - The indents are to be 4 spaces
9191
9292``` markdown
9393<!--example markdown document-->
0 commit comments