Update 'PYGUIDE.md'
This commit is contained in:
parent
508fefa3d0
commit
1647c7df3a
22
PYGUIDE.md
22
PYGUIDE.md
|
@ -95,15 +95,6 @@ always access your variable throught the method and avoid to access directly.
|
|||
|
||||
```
|
||||
|
||||
Attributes with known units should be explicit in method's names
|
||||
|
||||
```python
|
||||
|
||||
@property
|
||||
def distance_m(self):
|
||||
return self._distance
|
||||
```
|
||||
|
||||
### Coments
|
||||
|
||||
#### code documentation
|
||||
|
@ -137,6 +128,19 @@ all public classes, properties and methods must have code comments
|
|||
|
||||
```
|
||||
|
||||
Attributes with known units should be explicit in method's comment
|
||||
|
||||
```python
|
||||
|
||||
@property
|
||||
def distance(self):
|
||||
"""
|
||||
My class distance in meters
|
||||
:return: float
|
||||
"""
|
||||
return self._distance
|
||||
```
|
||||
|
||||
#### To do's
|
||||
|
||||
Pending to implement operations should be indicated with ToDo comments to highlight the missing operation
|
||||
|
|
Loading…
Reference in New Issue
Block a user