Skip to content

Commit d78be11

Browse files
authored
Merge pull request #166 from InsightLab/developer
added type hinting to .code-style.md
2 parents 17e98b1 + 39f70d2 commit d78be11

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

.code-style.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ We are using some tools to keep a default coding style in the project.
99

1010
---
1111

12+
## Docstrings and Type Hinting
13+
14+
We following the [Numpy](https://numpydoc.readthedocs.io/en/latest/format.html) docstring style with [PEP484](https://www.python.org/dev/peps/pep-0484/#abstract).
15+
16+
1217
## Links
1318
- <https://pre-commit.com/>
1419
- <https://www.codacy.com/>

.documentation.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Documentation
22

3-
We use sphinx to build and readthedocs to host the documentation,
4-
following the [Numpy Docstring](https://numpydoc.readthedocs.io/en/latest/format.html.)
3+
We use sphinx to build and readthedocs to host the documentation.
54

65
## How create doc with Sphinx
76
### 1. Getting to know Sphinx

pymove/preprocessing/filters.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -297,8 +297,6 @@ def outliers(
297297
if set to true the original dataframe will be altered to contain
298298
the result of the filtering, otherwise a copy will be returned, by default False
299299
300-
301-
302300
Returns
303301
-------
304302
DataFrame

0 commit comments

Comments
 (0)