From 25bdaab7d9115268d1aed8b7e791b16bd38358b0 Mon Sep 17 00:00:00 2001 From: Stefano Alberto Russo Date: Thu, 14 Mar 2024 14:25:42 +0100 Subject: [PATCH] Minor text fixes and improvements. --- Quickstart.ipynb | 2 +- README.md | 8 ++++---- docs/index.rst | 2 +- setup.py | 6 +++--- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/Quickstart.ipynb b/Quickstart.ipynb index 17dae62..7bded8c 100644 --- a/Quickstart.ipynb +++ b/Quickstart.ipynb @@ -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", diff --git a/README.md b/README.md index 7b90e01..e498400 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/index.rst b/docs/index.rst index e231c22..5eef14e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 diff --git a/setup.py b/setup.py index 8869acd..4188697 100644 --- a/setup.py +++ b/setup.py @@ -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)