Skip to content

Commit e9f8090

Browse files
authored
Merge pull request #229 from Forced-Alignment-and-Vowel-Extraction/bugfix/quartodoc
doc fixes
2 parents de88a44 + 97661af commit e9f8090

6 files changed

Lines changed: 5 additions & 10 deletions

File tree

docs/.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ _site/
33
reference/
44
_inv/
55
objects.txt
6-
_freeze
6+
_freeze
7+
**/*.quarto_ipynb

src/aligned_textgrid/mixins/mixins.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ class InTierMixins:
138138
139139
Attributes:
140140
tier_index (int):
141-
Index of the current entry within its tier
141+
Index of the current entry within its tier
142142
"""
143143

144144
## Tier operations

src/aligned_textgrid/points/points.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,8 +200,7 @@ def get_interval_index_at_time(
200200
tier (SequenceTier): A SequenceTier.
201201
202202
Returns:
203-
(int):
204-
The index of the SequenceInterval within which the point falls
203+
(int): The index of the SequenceInterval within which the point falls
205204
"""
206205
if tier and isinstance(tier, SequenceTier):
207206
int_idx = tier.get_interval_at_time(self.time)

src/aligned_textgrid/points/tiers.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -236,9 +236,6 @@ class PointsGroup(Sequence, TierGroupMixins, WithinMixins):
236236
Args:
237237
tiers (list[SequencePointTier]|PointsGroup):
238238
A list of SequencePointTiers
239-
240-
Attributes:
241-
A list of the entry classes
242239
"""
243240
def __init__(
244241
self,

src/aligned_textgrid/polar/polar_classes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ class PrStr(SequencePoint):
1212
1313
Attributes:
1414
...:
15-
All methods and attributes from SequencePoint
15+
All methods and attributes from SequencePoint
1616
certainty (str):
1717
If a '?' was appended to a point label, `'uncertain'`, otherwise
1818
`'certain'`

src/aligned_textgrid/sequences/tiers.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,6 @@ class SequenceTier(Sequence, TierMixins, WithinMixins):
7676
The minumum end time of the tier
7777
name (str):
7878
The name of the tier
79-
[] : Indexable. Returns a SequenceInterval
80-
: Iterable
8179
"""
8280
def __init__(
8381
self,

0 commit comments

Comments
 (0)