From 30d76c5c5bfba6727c195ecc1e36dcb7d1ba9105 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Piotr=20Ma=C5=9Blanka?= <piotr.maslanka@henrietta.com.pl>
Date: Wed, 1 Jul 2020 17:46:48 +0200
Subject: [PATCH] docs

---
 README.md           | 13 +++++++++----
 satella/__init__.py |  2 +-
 satella/time.py     |  8 ++++++++
 3 files changed, 18 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 563bff78..68b70b93 100644
--- a/README.md
+++ b/README.md
@@ -21,10 +21,10 @@ Satella contains, among other things:
 * a fully equipped [metrics library](satella/instrumentation/metrics)
     * alongside a fully metricized [ThreadPoolExecutor](satella/instrumentation/metrics/structures/threadpool.py)
 * helpful [exception handlers](satella/exception_handling)
-* common programming [idioms](satella/coding)
+* common programming [idioms and structures](satella/coding)
 
-Most Satella objects make heavy use of `__slots__`, so they are memory friendly and usable on embedded systems,
-where memory is at premium.
+Most Satella objects make heavy use of `__slots__`, so they are memory friendly and usable on
+embedded systems, where memory is at premium.
 
 Change log is kept as part of [release notes](https://github.com/piotrmaslanka/satella/releases).
 The [CHANGELOG.md](CHANGELOG.md) file is only to track changes since last release.
@@ -37,6 +37,11 @@ code taken from elsewhere on the internets, so this is copyright (c) respective
 
 # Running unit tests
 
+Tests run by default on 
+[Travis CI](https://travis-ci.org/github/piotrmaslanka/satella).
 Just build and run the attached 
 [Dockerfile](Dockerfile). 
-These tests run on Python 3.8
\ No newline at end of file
+These tests run on Python 3.8
+
+They pass on Windows too, but some tests 
+requiring POSIX-like functionality are skipped.
diff --git a/satella/__init__.py b/satella/__init__.py
index e7849d36..b21b204a 100644
--- a/satella/__init__.py
+++ b/satella/__init__.py
@@ -1 +1 @@
-__version__ = '2.8.15_a1'
+__version__ = '2.8.15_a2'
diff --git a/satella/time.py b/satella/time.py
index 33a13ba3..ac571d99 100644
--- a/satella/time.py
+++ b/satella/time.py
@@ -60,6 +60,14 @@ def time_ms() -> int:
 
 
 def time_us() -> int:
+    """
+    Syntactic sugar for
+
+    >>> from time import time
+    >>> int(time()*1000000)
+
+    This will try to use time.time_ns() if available
+    """
     try:
         return time.time_ns() // 1000
     except AttributeError:
-- 
GitLab