Update question terminology, make validation text more concise #189
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
drewoldag
added
documentation
drewoldag
requested review from
a team and
smcguire-cmu
and removed request for
a team
smcguire-cmu
reviewed
May 5, 2023
Contributor
smcguire-cmu
left a comment
smcguire-cmu
left a comment
There was a problem hiding this comment.
Thanks for making the changes! Just a few nit picks but mostly looks good
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We received some feedback, recorded in issue #182 that the term "module" in the copier questions wasn't precise enough, it was suggested that we change that to "package", which is more accurate. The vast majority of the files that were touched are simply propagating the change from
module_nametopackage_namethrough all the templates.It was also noted that for 80 character terminal windows the validation error text will be cut off, and doesn't scroll or wrap lines. I took a few swings at trying to get a carriage return or line break to render, but due to the way that the error is rendered, it is only displayed on a single line. (including a line break ,
<br>simply renders that string in the validation error message 🤷 )So I've tried to make the error message super concise to fit under the 80 character limit and I added more information about the regex validation in the "Starting a new project" RTD question table.