Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation of Segmenter #3261

Closed
sffc opened this issue Apr 5, 2023 · 0 comments · Fixed by #3269
Closed

Improve documentation of Segmenter #3261

sffc opened this issue Apr 5, 2023 · 0 comments · Fixed by #3269
Assignees
Labels
C-segmentation Component: Segmentation S-small Size: One afternoon (small bug fix or enhancement) T-docs-tests Type: Code change outside core library

Comments

@sffc
Copy link
Member

sffc commented Apr 5, 2023

There are a number of questions that have been raised, such as #3236, and why some segmenters return a breakpoint at index 0 but others not. We should provide 1-2 paragraphs of explanatory text for each of the 4 segmenters, with a link to the spec for more details.

@sffc sffc added T-docs-tests Type: Code change outside core library C-segmentation Component: Segmentation S-small Size: One afternoon (small bug fix or enhancement) labels Apr 5, 2023
@sffc sffc added this to the 1.2 Blocking ⟨P1⟩ milestone Apr 5, 2023
@sffc sffc mentioned this issue Apr 5, 2023
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-segmentation Component: Segmentation S-small Size: One afternoon (small bug fix or enhancement) T-docs-tests Type: Code change outside core library
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants