Skip to content

Commit d20f783

Browse files
authored
Merge pull request #11 from AUAS-Pulsar/readme
fixed subparagraph links and table of content links
2 parents cd86900 + c37a7e1 commit d20f783

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Creating a free and open source framework that contains the generic algorithms a
1717
1. [Example filterbank files](docs/gettingstarted.md#11-example-filterbank-files)
1818
2. [Import](docs/gettingstarted.md#12-import)
1919
2. [Filterbank tutorial](docs/filterbank.md)
20-
1. [Create filterbank object](docs/filterbank.md#21-create-filterbank-object)
21-
2. [Read header from filterbank data](docs/filterbank.md#22-read-header-from-filterbank-data)
20+
1. [Create filterbank object](docs/filterbank.md#21-create-a-filterbank-object)
21+
2. [Read header from filterbank data](docs/filterbank.md#22-read-the-header-from-filterbank-data)
2222
3. [Read filterbank file to 3d numpy array](docs/filterbank.md#23-read-filterbank-file-to-3d-numpy-array)
2323
4. [Select a range of data from the filterbank file](docs/filterbank.md#24-select-a-range-of-data-from-the-filterbank-file)

docs/filterbank.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,6 @@ filterbank = Filterbank(<PATH TO FILTERBANK FILE>, freq_range, time_range)
4141
The select_data method can be used to select a subset from the data read by the read_filterbank method.
4242
```
4343
filterbank.select_data(freq_range, time_range)
44-
```
44+
```
45+
46+
[Back to table of contents](../README.md)

docs/gettingstarted.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,6 @@
99
## 1.2 Import
1010
```
1111
from filterbank.filterbank import *
12-
```
12+
```
13+
14+
[Back to table of contents](../README.md)

0 commit comments

Comments
 (0)