From 4cdac747708e6c3d834ae727c3178a4c6cdba128 Mon Sep 17 00:00:00 2001
From: Stefan Reck <stefan.reck@fau.de>
Date: Tue, 13 Jul 2021 16:25:39 +0200
Subject: [PATCH] docs
---
docs/orcasong.rst | 14 +++++---------
1 file changed, 5 insertions(+), 9 deletions(-)
diff --git a/docs/orcasong.rst b/docs/orcasong.rst
index 0dfd92f..be00f22 100644
--- a/docs/orcasong.rst
+++ b/docs/orcasong.rst
@@ -105,16 +105,12 @@ like this:
from orcasong.core import FileGraph
-The FileGraph produces a list of nodes, each representing a hit.
-The length of this list has to be fixed, i.e. be the same for each event.
-Since the number of hits varies from event to event, some events will have to get
-padded, while others might get hits removed. The parameter ``max_n_hits``
-of FileGraph determines this fixed length:
-
-.. code-block:: python
-
- fg = FileGraph(max_n_hits=2000)
+ fg = FileGraph()
+The FileGraph produces a list of nodes, each representing a hit.
+Since the number of hits varies from event to event, the hits of all events are saved
+in a long list (2d array), and a seperate datasets is saved that can be used
+to identify which hits belong to which events.
General usage
-------------
--
GitLab