Skip to content

Commit e73ba68

Browse files
committed
docstrings
1 parent 5e803fa commit e73ba68

File tree

2 files changed

+22
-19
lines changed

2 files changed

+22
-19
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -200,23 +200,28 @@ You can create your own custom layout by specifying which views you'd like
200200
to see, and where they go. The basic window layout supports eight "zones",
201201
which are laid out as follows:
202202

203-
```
204-
+-----------------+-----------------+
205-
| [zone1 zone2] | [zone3 | [zone4 |
206-
+-----------------+ | +
207-
| [zone5 zone6] | zone7] | zone8] |
208-
+-----------------+-----------------+
209-
```
203+
+---------------+--------------+
204+
| zone1 zone2 | zone3 zone4 |
205+
+ + +
206+
| zone5 zone6 | zone7 zone8 |
207+
+---------------+--------------+
208+
209+
If a zone has free space below it or to the right of it, it will try to use it.
210+
Stretching downwards takes precedence over stretching rightwards.
211+
E.g. suppose your layout is only non-empty in zones 1, 4, 5, 6 and 7:
210212

211-
If zones are not included, the other zones take over their space. Hence if you'd
212-
like to show waveforms as a long view, you can set zone3 to display waveforms
213-
and then set zone7 to display nothing. The waveforms in zone3 will take over the
214-
blank space from zone7.
213+
+---------------+--------------+
214+
| zone1 | zone4 |
215+
+ + +
216+
| zone5 zone6 | zone7 |
217+
+---------------+--------------+
218+
219+
Then zone1 will stretch right-wards to make a three-zone view. Zone4 will stretch
220+
downwards to make a long two-zone view.
215221

216222
To specify your own layout, put the specification in a `.json` file. This should
217223
be a list of zones, and which views should appear in which zones. An example:
218224

219-
220225
**my_layout.json**
221226
```
222227
{

spikeinterface_gui/layout_presets.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,26 @@
33
import numpy as np
44

55
"""
6-
A preset depends on eight zones.
6+
A preset depends on eight zones, which are split into two sub-regions
77
88
+---------------+--------------+
9-
| zone1 zone2 zone3 zone4 |
9+
| zone1 zone2 | zone3 zone4 |
1010
+ + +
11-
| zone5 zone6 zone7 zone8 |
11+
| zone5 zone6 | zone7 zone8 |
1212
+---------------+--------------+
1313
1414
If a zone has free space below it or to the right of it, it will try to use it.
1515
Stretching downwards takes precedence over stretching rightwards.
1616
E.g. suppose your layout is only non-empty in zones 1, 4, 5, 6 and 7:
1717
1818
+---------------+--------------+
19-
| zone1 zone4 |
19+
| zone1 | zone4 |
2020
+ + +
21-
| zone5 zone6 zone7 |
21+
| zone5 zone6 | zone7 |
2222
+---------------+--------------+
2323
2424
Then zone1 will stretch right-wards to make a three-zone view. Zone4 will stretch
2525
downwards to make a long two-zone view.
26-
27-
If there is not a unique way to fill the gaps, some space will be left unused.
2826
"""
2927
_presets = {}
3028

0 commit comments

Comments
 (0)