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

building docs minor changes #1808

Merged
merged 1 commit into from
Mar 24, 2021
Merged

building docs minor changes #1808

merged 1 commit into from
Mar 24, 2021

Conversation

JRMeyer
Copy link
Member

@JRMeyer JRMeyer commented Mar 24, 2021

No description provided.

@JRMeyer JRMeyer requested a review from reuben March 24, 2021 02:26
Copy link
Collaborator

@reuben reuben left a comment

Choose a reason for hiding this comment

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

Just one comment.

doc/BUILDING.rst Outdated

If you'd like to build the 🐸STT binaries yourself, you'll need the following pre-requisites downloaded and installed:
You should **always** use our pre-built binaries, which are available with every `release <https://github.com/coqui-ai/STT/releases>`_, unless you have a very good reason to do build them yourself.
Copy link
Collaborator

Choose a reason for hiding this comment

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

So it's not always then? This language sounds condescending to me. Can you rephrase it as advice for users benefit instead of an order?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think this message needs to be very clear, so that no one accidentally wastes a day of their time trying to build something they never needed to build in the first place. Condescending is bad, obviously, so I'll make it more a clear suggestion than an order.

@reuben
Copy link
Collaborator

reuben commented Mar 24, 2021

Oh, and one small note for this and the other PR: please write proper commit messages, descriptive and capitalized. This is literally going to stay around forever :)

@JRMeyer
Copy link
Member Author

JRMeyer commented Mar 24, 2021

@reuben would you say these guidelines are good for commit messages? https://chris.beams.io/posts/git-commit/

@reuben
Copy link
Collaborator

reuben commented Mar 24, 2021

@reuben would you say these guidelines are good for commit messages? https://chris.beams.io/posts/git-commit/

Yep those are really good

@JRMeyer JRMeyer merged commit cb75dcb into coqui-ai:main Mar 24, 2021
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.

2 participants