From 5c7c3afe9a63fc9fd2ead92ee3775217adcc5c3f Mon Sep 17 00:00:00 2001
From: u214892 <u214892@sbb.ch>
Date: Thu, 13 Jun 2019 08:25:33 +0200
Subject: [PATCH] #57 added documentation
---
AUTHORS.rst | 6 +++++-
docs/FAQ.rst | 16 ++++++++++++++++
2 files changed, 21 insertions(+), 1 deletion(-)
diff --git a/AUTHORS.rst b/AUTHORS.rst
index 39a80170..f7ab2e08 100644
--- a/AUTHORS.rst
+++ b/AUTHORS.rst
@@ -9,7 +9,11 @@ Development
* G Spigler <giacomo.spigler@gmail.com>
-* A Egli <adrian.egli@sbb.ch>
+* A Egli <adrian.egli@sbb.ch>
+
+* E Nygren <erik.nygren@sbb.ch>
+
+* Ch. Eichenberger <christian.markus.eichenberger@sbb.ch>
* Mattias Ljungström
diff --git a/docs/FAQ.rst b/docs/FAQ.rst
index b7055321..909fa2c1 100644
--- a/docs/FAQ.rst
+++ b/docs/FAQ.rst
@@ -17,3 +17,19 @@ Frequently Asked Questions (FAQs)
export LC_ALL=en_US.utf-8
export LANG=en_US.utf-8
+
+- We use `importlib-resources`_ to read from local files.
+ Sample usages:
+
+ .. code-block:: python
+ from importlib_resources import path
+
+ with path(package, resource) as file_in:
+ new_grid = np.load(file_in)
+
+ .. code-block:: python
+ from importlib_resources import read_binary
+ load_data = read_binary(package, resource)
+ self.set_full_state_msg(load_data)
+
+ .. _importlib-resources: https://importlib-resources.readthedocs.io/en/latest/
--
GitLab