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

README and Function Documentation #22

Merged
merged 11 commits into from
May 26, 2023
Merged

README and Function Documentation #22

merged 11 commits into from
May 26, 2023

Conversation

howardbaek
Copy link
Member

Overview

I originally planned on working on the README, function roxygen comments, and the coqui TTS vignettes, but this branch grew way too much with all the commits for the README and the function roxygen, so I will work on the coqui vignette on another branch.

What I did

  1. README: Gave an overview of text2speech, how to check for authentication, list out different voices, and synthesize speech with the different services
  2. Added a play_audio() function that lets you play audio in a browser.
  3. Deleted tts_synthesis.R and moved tts() inside tts.R because that's where all the tts_*() functions live.
  4. Deleted tts_**_auth.R and tts_coqui_installed.R and moved the authorization functions for the different services inside tts_auth.R.
  5. Renamed tts_**_authenticated() to tts_**_check() to avoid confusion with tts_**_auth()
  6. Used @rdname to pul related functions into one documentation page.

Overall, the package shows more structure and documentation within its functions

@howardbaek howardbaek linked an issue May 25, 2023 that may be closed by this pull request
Copy link
Contributor

@cansavvy cansavvy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After walking through these code changes synchronously with @howardbaek , I think this looks good and ready to go.

The Files changed tab is a bit confusing to follow because the code is reorganized, but there are no actual deleting or adding bits of code.

@howardbaek howardbaek merged commit 11388d1 into main May 26, 2023
3 of 4 checks passed
@howardbaek howardbaek deleted the 21-documentation branch June 9, 2023 18:07
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

Successfully merging this pull request may close these issues.

Documentation
2 participants