Permalink
Browse files

docs

  • Loading branch information...
1 parent cd99b72 commit 514442e08e023fcaac8dd974a41116e86268f893 @zebpalmer committed Mar 11, 2013
Showing with 10 additions and 7 deletions.
  1. +2 −1 weatheralerts/__init__.py
  2. +8 −6 weatheralerts/weather_alerts.py
@@ -11,7 +11,8 @@
http://github.com/zebpalmer/WeatherAlerts
**Original Author:**
- Zeb Palmer http://www.zebpalmer.com
+ Zeb Palmer
+ http://www.zebpalmer.com
**Documentation:**
@@ -7,14 +7,16 @@
class WeatherAlerts(object):
'''
WeatherAlerts object that controls interaction with the NWS CAP alerts feed as well and varios geo data sources.
- Most interaction from users, scripts, etc will be through the api provided by this class. So, as we approach a
- more stable project, the API in this class will also become more stable and maintain backwards compatibility.
+ Most interaction from users, scripts, etc will be through the api provided by this `WeatherAlerts` class.
+ So, as we approach a more stable project, the API in this class will also become more stable.
- *Defaults to National Feed, it can be quite large at times, you probably don't want to parse it very often.
- *Set a state to see all alerts on your state feed.
- *For local alerts only, set samecodes to a single samecode string, or list of samecode strings. This will
+ * Defaults to National Feed, it can be quite large at times, you probably don't want to parse it very often.
+
+ * Set `state` to see all alerts on your state feed.
+ * For local alerts only, set `samecodes` to a single samecode string, or list of samecode strings. This will
pull your state feed automatically.
- *Cachetime is set in minutes, default is 3.
+
+ * `cachetime` is set in minutes, default is 3.
'''
def __init__(self, state=None, samecodes=None, load=True, cachetime=3):

0 comments on commit 514442e

Please sign in to comment.