Skip to content

Update tone_detector() API description #919

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 23, 2024
Merged

Update tone_detector() API description #919

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion pythainlp/util/syllable.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,17 @@ def tone_detector(syllable: str) -> str:
"""
Thai tone detector for syllables

Return tone of a syllable.

- l: low
- m: mid
- r: rising
- f: falling
- h: high
- empty string: cannot be detected

:param str syllable: Thai syllable
:return: syllable's tone (l, m, h, r, f or empty if it cannot be detected)
:return: syllable's tone (l, m, h, r, f) or empty if it cannot be detected
:rtype: str

:Example:
Expand Down