You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sphinx/contributing.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
# Contributing
2
2
3
-
Contributing is easy anwd welcome
3
+
Contributing is easy and welcome
4
4
5
5
You can contribute to PyOWM in a lot of ways:
6
6
7
7
- reporting a reproducible defect (eg. bug, installation crash, ...)
8
8
- make a wish for a reasonable new feature
9
9
- increase the test coverage
10
10
- refactor the code
11
-
- improve PyOWM reach on platforms (eg. bundle it for Linux distros, managers, oding, testing, packaging, reporting issues) are welcome!
11
+
- improve PyOWM reach on platforms (eg. bundle it for Linux distros, managers, coding, testing, packaging, reporting issues) are welcome!
12
12
13
13
And last but not least... use it! Use PyOWM in your own projects, as [lots of people already do](https://github.com/csparpa/pyowm/wiki/Community-Projects-using-PyOWM).
14
14
@@ -26,9 +26,9 @@ That's simple: what you need to do is just open a new issue on GitHub.
26
26
27
27
## Bug reports - general principles
28
28
In order to allow the community to understand what the bug is, *you should provide as much information as possible* on it.
29
-
Vague or succint bug reports are not useful and will very likely result in follow ups needed.
29
+
Vague or succinct bug reports are not useful and will very likely result in follow ups needed.
30
30
31
-
*Only bugs related to PyOWM will be addressed*: it might be that you're using PyOWM in a broader context (eg. a webapplication)
31
+
*Only bugs related to PyOWM will be addressed*: it might be that you're using PyOWM in a broader context (eg. a web application)
32
32
so bugs affecting the broader context are out of scope - unless they are caused in chain to PyOWM issues.
33
33
34
34
Also, please do understand that we can only act on *reproducible bugs*: this means that a bug does not exist if it is
@@ -74,7 +74,7 @@ just run:
74
74
75
75
`pip install -r dev-requirements.txt`
76
76
77
-
It is adviced that you do it on a [virtualenv](https://virtualenv.pypa.io/en/stable/).
77
+
It is advised that you do it on a [virtualenv](https://virtualenv.pypa.io/en/stable/).
-*Trigger*: collection of alerts to be met over specified areas and within a specified time frame according to specified weather params conditions
92
-
-*Condition*: rule for matching a weather measuerment with a specified threshold
92
+
-*Condition*: rule for matching a weather measurement with a specified threshold
93
93
-*Alert*: whenever a condition is met, an alert is created (or updated) and can be polled to verify when it has been met and what the actual weather param value was.
94
94
-*Area*: geographic area over which the trigger is checked
95
95
-*AlertChannel*: as OWM plans to add push-oriented alert channels (eg. push notifications), we need to encapsulate this into a specific class
@@ -283,8 +283,8 @@ A Trigger is the local proxy for the corresponding entry on the OWM API: Trigger
- start_after_millis: _with resepect to the time when the trigger will be crated on the Alert API_, how many milliseconds after should it begin to be checked for conditions matching
287
-
- end_after_millis: _with resepect to the time when the trigger will be crated on the Alert API_, how many milliseconds after should it end to be checked for conditions matching
286
+
- start_after_millis: _with respect to the time when the trigger will be created on the Alert API_, how many milliseconds after should it begin to be checked for conditions matching
287
+
- end_after_millis: _with respect to the time when the trigger will be created on the Alert API_, how many milliseconds after should it end to be checked for conditions matching
288
288
- alerts: a list of `pyowm.alertapi30.alert.Alert` instances, which are the alerts that the trigger has fired so far
289
289
- conditions: a list of `pyowm.alertapi30.condition.Condition` instances
290
290
- area: a list of `pyowm.utils.geo.Geometry` instances, representing the geographic area on which the trigger's conditions need to be checked
0 commit comments