Skip to content

Commit 75d28d4

Browse files
docs(api): clarify ilgs span whitespace coverage
1 parent 2b81647 commit 75d28d4

10 files changed

Lines changed: 42 additions & 16 deletions

File tree

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 5
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/isaacus%2Fisaacus-184e5212bf13e5e8466cc91706965bb8a04b6c4d9b085f5a966d2247d8ab4f3a.yml
3-
openapi_spec_hash: 5c647e80faf91f601598831eae3f5904
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/isaacus%2Fisaacus-f97414fc062dd07f3ac5066afe3decb2d6bff49ff129c3633096d59d0d28ded9.yml
3+
openapi_spec_hash: 90f19133c18780ddeeebdf9dd741352b
44
config_hash: 9040e7359f066240ad536041fb2c5185

src/isaacus/types/ilgs/v1/crossreference.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ class Crossreference(BaseModel):
3333
wholly nested. Spans of the exact same type (e.g., segments) will never be
3434
duplicated.
3535
36-
A span cannot be empty and will never start or end at whitespace.
36+
A span cannot be empty and will never start or end at whitespace (though a
37+
span's `end` index, being an exclusive index, may obviosuly land on a whitespace
38+
character).
3739
3840
Note that, when using programming languages other than Python (which uses
3941
zero-based, half-open, Unicode code point-spaced string indexing), indices may

src/isaacus/types/ilgs/v1/document.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,9 @@ class Document(BaseModel):
4949
wholly nested. Spans of the exact same type (e.g., segments) will never be
5050
duplicated.
5151
52-
A span cannot be empty and will never start or end at whitespace.
52+
A span cannot be empty and will never start or end at whitespace (though a
53+
span's `end` index, being an exclusive index, may obviosuly land on a whitespace
54+
character).
5355
5456
Note that, when using programming languages other than Python (which uses
5557
zero-based, half-open, Unicode code point-spaced string indexing), indices may
@@ -65,7 +67,9 @@ class Document(BaseModel):
6567
wholly nested. Spans of the exact same type (e.g., segments) will never be
6668
duplicated.
6769
68-
A span cannot be empty and will never start or end at whitespace.
70+
A span cannot be empty and will never start or end at whitespace (though a
71+
span's `end` index, being an exclusive index, may obviosuly land on a whitespace
72+
character).
6973
7074
Note that, when using programming languages other than Python (which uses
7175
zero-based, half-open, Unicode code point-spaced string indexing), indices may

src/isaacus/types/ilgs/v1/external_document.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ class ExternalDocument(BaseModel):
2525
wholly nested. Spans of the exact same type (e.g., segments) will never be
2626
duplicated.
2727
28-
A span cannot be empty and will never start or end at whitespace.
28+
A span cannot be empty and will never start or end at whitespace (though a
29+
span's `end` index, being an exclusive index, may obviosuly land on a whitespace
30+
character).
2931
3032
Note that, when using programming languages other than Python (which uses
3133
zero-based, half-open, Unicode code point-spaced string indexing), indices may

src/isaacus/types/ilgs/v1/location.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ class Location(BaseModel):
2323
wholly nested. Spans of the exact same type (e.g., segments) will never be
2424
duplicated.
2525
26-
A span cannot be empty and will never start or end at whitespace.
26+
A span cannot be empty and will never start or end at whitespace (though a
27+
span's `end` index, being an exclusive index, may obviosuly land on a whitespace
28+
character).
2729
2830
Note that, when using programming languages other than Python (which uses
2931
zero-based, half-open, Unicode code point-spaced string indexing), indices may

src/isaacus/types/ilgs/v1/person.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ class Person(BaseModel):
2323
wholly nested. Spans of the exact same type (e.g., segments) will never be
2424
duplicated.
2525
26-
A span cannot be empty and will never start or end at whitespace.
26+
A span cannot be empty and will never start or end at whitespace (though a
27+
span's `end` index, being an exclusive index, may obviosuly land on a whitespace
28+
character).
2729
2830
Note that, when using programming languages other than Python (which uses
2931
zero-based, half-open, Unicode code point-spaced string indexing), indices may

src/isaacus/types/ilgs/v1/quote.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ class Quote(BaseModel):
3434
wholly nested. Spans of the exact same type (e.g., segments) will never be
3535
duplicated.
3636
37-
A span cannot be empty and will never start or end at whitespace.
37+
A span cannot be empty and will never start or end at whitespace (though a
38+
span's `end` index, being an exclusive index, may obviosuly land on a whitespace
39+
character).
3840
3941
Note that, when using programming languages other than Python (which uses
4042
zero-based, half-open, Unicode code point-spaced string indexing), indices may

src/isaacus/types/ilgs/v1/segment.py

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,9 @@ class Segment(BaseModel):
139139
wholly nested. Spans of the exact same type (e.g., segments) will never be
140140
duplicated.
141141
142-
A span cannot be empty and will never start or end at whitespace.
142+
A span cannot be empty and will never start or end at whitespace (though a
143+
span's `end` index, being an exclusive index, may obviosuly land on a whitespace
144+
character).
143145
144146
Note that, when using programming languages other than Python (which uses
145147
zero-based, half-open, Unicode code point-spaced string indexing), indices may
@@ -155,7 +157,9 @@ class Segment(BaseModel):
155157
wholly nested. Spans of the exact same type (e.g., segments) will never be
156158
duplicated.
157159
158-
A span cannot be empty and will never start or end at whitespace.
160+
A span cannot be empty and will never start or end at whitespace (though a
161+
span's `end` index, being an exclusive index, may obviosuly land on a whitespace
162+
character).
159163
160164
Note that, when using programming languages other than Python (which uses
161165
zero-based, half-open, Unicode code point-spaced string indexing), indices may
@@ -171,7 +175,9 @@ class Segment(BaseModel):
171175
wholly nested. Spans of the exact same type (e.g., segments) will never be
172176
duplicated.
173177
174-
A span cannot be empty and will never start or end at whitespace.
178+
A span cannot be empty and will never start or end at whitespace (though a
179+
span's `end` index, being an exclusive index, may obviosuly land on a whitespace
180+
character).
175181
176182
Note that, when using programming languages other than Python (which uses
177183
zero-based, half-open, Unicode code point-spaced string indexing), indices may
@@ -202,7 +208,9 @@ class Segment(BaseModel):
202208
wholly nested. Spans of the exact same type (e.g., segments) will never be
203209
duplicated.
204210
205-
A span cannot be empty and will never start or end at whitespace.
211+
A span cannot be empty and will never start or end at whitespace (though a
212+
span's `end` index, being an exclusive index, may obviosuly land on a whitespace
213+
character).
206214
207215
Note that, when using programming languages other than Python (which uses
208216
zero-based, half-open, Unicode code point-spaced string indexing), indices may

src/isaacus/types/ilgs/v1/span.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ class Span(BaseModel):
1010
1111
All spans are globally laminar and well-nested similar to XML—it is impossible for any two spans to partially overlap; they can only be disjoint, adjacent, or wholly nested. Spans of the exact same type (e.g., segments) will never be duplicated.
1212
13-
A span cannot be empty and will never start or end at whitespace.
13+
A span cannot be empty and will never start or end at whitespace (though a span's `end` index, being an exclusive index, may obviosuly land on a whitespace character).
1414
1515
Note that, when using programming languages other than Python (which uses zero-based, half-open, Unicode code point-spaced string indexing), indices may need to be translated accordingly (for example, JavaScript slices into UTF-16 code units instead of Unicode code points).
1616
"""

src/isaacus/types/ilgs/v1/term.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ class Term(BaseModel):
2222
wholly nested. Spans of the exact same type (e.g., segments) will never be
2323
duplicated.
2424
25-
A span cannot be empty and will never start or end at whitespace.
25+
A span cannot be empty and will never start or end at whitespace (though a
26+
span's `end` index, being an exclusive index, may obviosuly land on a whitespace
27+
character).
2628
2729
Note that, when using programming languages other than Python (which uses
2830
zero-based, half-open, Unicode code point-spaced string indexing), indices may
@@ -38,7 +40,9 @@ class Term(BaseModel):
3840
wholly nested. Spans of the exact same type (e.g., segments) will never be
3941
duplicated.
4042
41-
A span cannot be empty and will never start or end at whitespace.
43+
A span cannot be empty and will never start or end at whitespace (though a
44+
span's `end` index, being an exclusive index, may obviosuly land on a whitespace
45+
character).
4246
4347
Note that, when using programming languages other than Python (which uses
4448
zero-based, half-open, Unicode code point-spaced string indexing), indices may

0 commit comments

Comments
 (0)