Skip to content

Commit

Permalink
Minor text fixes and improvements.
Browse files Browse the repository at this point in the history
  • Loading branch information
sarusso committed Mar 14, 2024
1 parent 0b7b616 commit 25bdaab
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion Quickstart.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"source": [
"## Propertime Quickstart\n",
"\n",
"Propertime is an attempt at implementing proper time management in Python, by fully embracing the extra complications arising due to the intrinsic need of conflating together physical and calendar time instead of neglecting them.\n",
"Propertime is an attempt at implementing proper time management in Python, by fully embracing the extra complications arising due to the intrinsic need of conflating together physical and calendar time, instead of neglecting them.\n",
"\n",
"In a nutshell, it provides two main classes: the ``Time`` class for representing time (similar to a datetime) and the ``TimeSpan`` class for representing spans of time (similar to a timedelta). Such classes play nice with Python datetimes so that you can mix and match and use them only when needed.\n",
"\n",
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ An attempt at proper time management in Python.
## Introduction


Propertime is an attempt at implementing proper time management in Python, by fully embracing the extra complications arising due to the intrinsic need of conflating together physical and calendar time instead of neglecting them.
Propertime is an attempt at implementing proper time management in Python, by fully embracing the extra complications arising due to the intrinsic need of conflating together physical and calendar time, instead of neglecting them.

These include, but are not limited to: time representations, time zones, UTC offsets, daylight saving times, undefined calendar time operations and variable length time spans.
These include, but are not limited to: time formats and representations, time zones, UTC offsets, daylight saving times, undefined calendar time operations and variable length time spans.

For example, while physical time (seconds, minutes and hours) is always well-defined, calendar time (days, weeks, months and years) is entirely dependent on human conventions and it is often ill-defined: the time of a day without a time zone does not make much sense, a generic day can last either 23, 24 or 25 hours depending on the daylight saving time (DST) switch, and the result of adding a month to the 31st of January is just not defined.

Propertime tries to embrace such complexity and eliminate ambiguity without overcomplicating the code or its interfaces, with the intent of providing a viable solution for common time management issues.
Propertime tries to embrace such complexity and eliminate ambiguity without overcomplicating the code or its interfaces, with the intent of providing a viable solution for common time management challenges.

In a nutshell, it provides two main classes: the ``Time`` class for representing time (similar to a datetime) and the ``TimeSpan`` class for representing time spans (similar to a timedelta).

Such classes are implemented assuming two strict hypotheses:
Such classes are implemented assuming two strict base hypotheses:

- **Time** is a floating point number corresponding the number of seconds after the zero on the time axis (Epoch), which is set to 1st January 1970 UTC. Any other representations (as dates and hours, time zones, daylight saving times) are built on top of it.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Welcome to Propertime API documentation!

Propertime is an attempt at implementing proper time management in Python,
by fully embracing the extra complications arising due to the intrinsic need of
conflating together physical and calendar time instead of neglecting them.
conflating together physical and calendar time, instead of neglecting them.

In a nutshell, it provides two main classes: the ``Time`` class for representing
time (similar to a datetime) and the ``TimeUnit`` class for representing units
Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
long_description="""
Propertime is an attempt at implementing proper time management in Python,
by fully embracing the extra complications arising due to the intrinsic need of
conflating together physical and calendar time instead of neglecting them.
conflating together physical and calendar time, instead of neglecting them.
In a nutshell, it provides two main classes: the ``Time`` class for representing
time (similar to a datetime) and the ``TimeUnit`` class for representing units
of time (similar to timedelta). Such classes play nice with Python datetimes so
time (similar to a datetime) and the ``TimeSpan`` class for representing units
of time (similar to a timedelta). Such classes play nice with Python datetimes so
that you can mix and match and use them only when needed.
You can have a look at the [README](https://github.com/sarusso/Propertime/blob/main/README.md)
Expand Down

0 comments on commit 25bdaab

Please sign in to comment.