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

Poor naming for functions taking or producing strings. #1

Open
guygastineau opened this issue Jan 4, 2023 · 1 comment
Open

Poor naming for functions taking or producing strings. #1

guygastineau opened this issue Jan 4, 2023 · 1 comment

Comments

@guygastineau
Copy link
Owner

I started out just following the naming conventions from the festival library itself. They use the word text where I have chosen to use the datatype String. This could result in confusion in the haskell ecosystem, since text usually refers to the datatype Text and the package whence it hails.

@guygastineau
Copy link
Owner Author

I think sayText should just be say for example.

This would also open the possibility of a parallel Text based API without confusion, although I don't think it is necessary. Long texts will take a REALLY long time for waveform synthesis and the flow/timing in the speech won't be great, so users are incentivized to break longer text into several small snippets. Therefore, sticking with String is probably fine, but we will still want to change the naming conventions to avoid confusion for library users.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant