typo fixes, markdown fixes

Author: nickmaccarthy

README.md

@@ -3,31 +3,35 @@
 # Python Datemath
 
 ## What?
+
 A date math (aka datemath) parser compatiable with the elasticsearch 'date math' format
 
 ## Why?
-Working with date objects in python has always been interesting.  Having a background in php, I have been looking for quite some time ( no pun intended ) for a way to do date time interpolation similar to php's ```strtotime()``` function.  While the arrow module comes close, I needed something that could turn date math type strings into datetime objects for use in tattle.io and other projects I use in elasticsearch.  I have found even more uses for it, including AWS cloudwatch and various other projects and hopefully you will too.
 
-## What is date math ?
+Working with date objects in python has always been interesting.  Having a background in php, I have been looking for quite some time ( no pun intended ) for a way to do date time interpolation similar to php's ```strtotime()``` function.  While the arrow module comes close, I needed something that could turn date math type strings into datetime objects for use in [tattle.io](http://tattle.io) and other projects I use in elasticsearch.  I have found even more uses for it, including AWS cloudwatch and various other projects and hopefully you will too.
+
+## What is date math?
+
 Date Math is the short hand arithmetic to find relative time to fixed moments in date and time. Similar to the SOLR date math format, Elasticsearch has its own built in format for short hand date math and this module aims to support that same coverage in python.
 
 Documentation from elasticsearch:
-http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping-date-format.html#date-math
+[http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping-date-format.html#date-math](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping-date-format.html#date-math)
 
 > The date type supports using date math expression when using it in a query/filter (mainly makes sense in range query/filter).
-
+>
 > The expression starts with an "anchor" date, which can be either now or a date string (in the applicable format) ending with `||`.
-
+>
 > It can then follow by a math expression, supporting `+`, `-` and `/` (rounding).
-
+>
 > The units supported are `y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute), and `s` (second).
-
+>
 > Here are some samples: `now+1h`, `now+1h+1m`, `now+1h/d`, `2012-01-01||+1M/d`.
-
+>
 > Note, when doing range type searches, and the upper value is inclusive, the rounding will properly be rounded to the ceiling instead of flooring it.
 
 ## Unit Maps
-```
+
+```yaml
 y or Y      =   'year'
 M           =   'month'
 m           =   'minute'
@@ -38,12 +42,16 @@ s or S      =   'second'
 ```
 
 ## Install
+
 ```python
 pip install python-datemath
 ```
+
 ## Examples
-Assuming our datetime is currently: '2016-01-01T00:00:00-00:00'
-```
+
+Assuming our datetime is currently: `2016-01-01T00:00:00-00:00`
+
+```yaml
 Expression:                 Result:
 now-1h                      2015-12-31T23:00:00+00:00
 now-1y                      2015-01-01T00:00:00+00:00
@@ -64,9 +72,10 @@ now/Y                       2016-12-31T23:59:59+00:00
 ```
 
 ## Usage
+
 By default datemath return an arrow date object representing your timestamp.  
 
-```
+```python
 >>> from datemath import dm
 >>>
 >>> dm('now+1h')
@@ -93,7 +102,8 @@ By default datemath return an arrow date object representing your timestamp.
 
 If you would rather have a string, you can use arrow's ```.format()``` method.
 > For for info on string formatting, check out arrows tokens section: http://crsmithdev.com/arrow/#tokens
-```
+
+```python
 >>> from datemath import dm
 >>>
 >>> src_timestamp = dm('2016-01-01')
@@ -106,11 +116,11 @@ If you would rather have a string, you can use arrow's ```.format()``` method.
 >>>
 >>> new_timestamp.format('YYYY.MM.DD')
 u'2015.12.18'
->>>
 ```
 
 Rather have a python datetime object instead? Just pass along the 'datetime' type
-```
+
+```python
 from datemath import dm
 >>> dm('now', type='datetime')
 datetime.datetime(2016, 1, 22, 22, 58, 28, 338060, tzinfo=tzutc())
@@ -120,7 +130,8 @@ datetime.datetime(2016, 1, 24, 22, 57, 45, 394470, tzinfo=tzutc())
 ```
 
 Or you can just import the `datemath` module, this will always give us a native `datetime` object
-```
+
+```python
 >>> from datemath import datemath
 >>>
 >>> datemath('2016-01-01T16:20:00||/d', roundDown=False)
@@ -130,24 +141,26 @@ datetime.datetime(2016, 1, 1, 23, 59, 59, 999999, tzinfo=tzutc())
 >>> # roundDown=True is default and implied
 >>> datemath('2016-01-01T16:20:00||/d')
 datetime.datetime(2016, 1, 1, 0, 0, tzinfo=tzutc())
->>>
 ```
 
 If you want a Epoch timestamp back instead, we can do that.  
+
 ```python
 >>> dm('now+2d-1m', type='timestamp')
 1453676321
 ```
 
 ## What timezone are my objects in?
+
 By default all object returned by datemath are in UTC.  
 
-If you want them them back in a different timezone, just pass along the ```tz``` argument.  Timezone list can be found here: https://gist.github.com/pamelafox/986163
+If you want them them back in a different timezone, just pass along the ```tz``` argument.  Timezone list can be found here: [https://gist.github.com/pamelafox/986163](https://gist.github.com/pamelafox/986163)
 
 If you provide a timezone offset in your timestring, datemath will return your time object as that timezone offset in the string.
 
 Note - currently timestrings with a timezone offset and the usage of the ```tz``` argument will result in the time object being returned with the timezone of what was in the timezone offset in the original string
-```
+
+```python
 >>> from datemath import dm 
 >>>
 >>> dm('now')
@@ -166,20 +179,21 @@ Note - currently timestrings with a timezone offset and the usage of the ```tz``
 >>> dm('2016-01-01T00:00:00-05:00')
 <Arrow [2016-01-01T00:00:00-05:00]>
 >>>
->>> # Timestring with TZooffset with datemath added (again, TS must be in ISO8601)
+>>> # Timestring with TZ offset with datemath added (again, TS must be in ISO8601)
 >>> dm('2016-01-01T00:00:00-05:00||+2d+3h+5m')
 <Arrow [2016-01-03T03:05:00-05:00]>
 >>>
 >>> # Note, timestrings with TZ offsets will be returned as the timezone of the offset in the string even if the "tz" option is used. 
 >>> dm('2016-01-01T00:00:00-05:00', tz='US/Central')
 <Arrow [2016-01-01T00:00:00-05:00]>
->>>
 ```
 
 ## Debugging
+
 If you would like more verbose output to debug the process of what datemath is doing, simply set `export DATEMATH_DEBUG=true` in your shell then run some datemath tests.  To stop debugging, run `unset DATEMATH_DEBUG`.
 
 ## Changes
+
 See CHANGELOG.md
 
 # Happy date math'ing!