CERC/hub
58
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases 84 Wiki Activity

Update 'PYGUIDE.md'

Browse Source
This commit is contained in:
Guille 2020-06-09 12:01:47 -04:00
parent 508fefa3d0
commit 1647c7df3a
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
PYGUIDE.md
View File

@ -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 ### Coments
#### code documentation #### 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 #### To do's
Pending to implement operations should be indicated with ToDo comments to highlight the missing operation Pending to implement operations should be indicated with ToDo comments to highlight the missing operation