Skip to content

Commit

Permalink
moar docs
Browse files Browse the repository at this point in the history
  • Loading branch information
myusuf3 committed Jan 23, 2013
1 parent 6b3eede commit fbf13f1
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
10 changes: 5 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ Delorean: Time Travel Made Easy

This document describes Delorean v\ |version|.

`Delorean` is a library for clearing up the inconvenient truths that arise dealing with datetimes in Python. Understanding that timing is a delicate enough of a problem to capture in software `delorean` hopes to provide a cleaner less troublesome solution to shifting, manipulating, generating `datetimes`.
`Delorean` is a library for clearing up the inconvenient truths that arise dealing with datetimes in Python. Understanding that timing is a delicate enough of a problem `delorean` hopes to provide a cleaner less troublesome solution to shifting, manipulating, generating `datetimes`.

Delorean stands on the shoulders of giants `pytz <http://pytz.sourceforge.net/>`_ and `dateutil <http://labix.org/python-dateutil>`_

It will provide natural language improvements for manipulating time, as well as datetime abstractions for ease of use. The overall goal is to improve datetime manipulations, with a little bit of software and philsophy.
`Delorean` will provide natural language improvements for manipulating time, as well as datetime abstractions for ease of use. The overall goal is to improve datetime manipulations, with a little bit of software and philsophy.

Pretty much make you a badass, time traveller.

Expand All @@ -41,7 +41,7 @@ Now lets warm up the `delorean`::
from delorean import Delorean

d = Delorean(timezone="US/Eastern")
return d
return d.dateime

Look at you looking all fly. This was just a test drive checkout out what else
`delorean` can help with below.
Expand All @@ -50,9 +50,9 @@ Guide
=====

.. toctree::
:maxdepth: 3
:maxdepth: 2

copyright
license
install
quickstart
interface
Expand Down
2 changes: 1 addition & 1 deletion docs/copyright.rst → docs/license.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright
License
=========

Copyright (c) 2012 Mahdi Yusuf
Expand Down
6 changes: 3 additions & 3 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Truncation
^^^^^^^^^^
Often times we dont care how many milliseconds or even seconds that present in our datetime object. It often becomes a nuisance to retrieve `datetimes` that for example occur in the same minute. You would have to through the annoying process of replacing zero for the units you don't care for then doing a comparison.

`Delorean` comes with a method that allows you to easily truncate to different unit of time milliseconds, second, minute, hour, etc.
`Delorean` comes with a method that allows you to easily truncate to different unit of time millisecond, second, minute, hour, etc.
::

>>> d = Delorean()
Expand Down Expand Up @@ -122,7 +122,7 @@ Ambiguous cases

There might be cases where the string passed to parse is a bit ambiguous for example. In the case where `2013-05-06` is passed is this May 6th, 2013 or is June 5th, 2013?

`Delorean` makes the assumptions that ``dayfirst=True`` and ``yearfirst=True`` this will lead to the following precedence.
precedence`Delorean` makes the assumptions that ``dayfirst=True`` and ``yearfirst=True`` this will lead to the following precedence.


If dayfirst is True and yearfirst is True:
Expand All @@ -137,7 +137,7 @@ So for example with default parameters `Delorean` will return '2013-05-06' May 6
>>> parse("2013-05-06")
Delorean(datetime=2013-05-06 00:00:00+00:00, timezone=UTC)

Here are the predecene for the remaining combinations of ``dayfirst`` and ``yearfirst``.
Here are the precedence for the remaining combinations of ``dayfirst`` and ``yearfirst``.

If dayfirst is False and yearfirst is False:

Expand Down

0 comments on commit fbf13f1

Please sign in to comment.