Skip to content

Commit b701b07

Browse files
committed
make the questions more coherent and descriptive
1 parent 55b80ed commit b701b07

File tree

5 files changed

+18
-14
lines changed

5 files changed

+18
-14
lines changed

copier/questions/essential.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
# Essential questions
33
package_name:
44
type: str
5-
placeholder: my_python_package
6-
help: Enter the name of the Python package.
5+
placeholder: your_python_package
6+
help: Enter the name of the Python package
77
validator: >-
88
{% if not (package_name | regex_search('^[a-z][a-z0-9\_]+$')) %}
99
Package name must start with a letter, followed one or more letters, digits or underscores all lowercase
@@ -22,10 +22,12 @@ full_name:
2222
help: Enter your full name
2323
validator: >-
2424
{% if not full_name %}
25-
Name cannot be empty
25+
Full name cannot be empty!
2626
{% endif %}
2727
license:
2828
type: str
29+
default: "Apachev2"
30+
help: "Select a license (see: https://choosealicense.com)"
2931
choices:
3032
Apache License, Version 2.0:
3133
value: Apachev2
@@ -41,4 +43,3 @@ license:
4143
value: GNULesserv3
4244
Other (add your own license):
4345
value: Other
44-
default: "Apachev2"

copier/questions/features_code_quality.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ SelectCodeQualityFeatures:
1414
help: Select code quality features
1515
multiselect: true
1616
choices:
17-
Local tests:
17+
Unit tests (using pytest):
1818
value: AddLocalTests_flag
1919
# validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
20-
GitHub Actions (selection on the next menu):
20+
GitHub Actions (select in the next step):
2121
value: SelectGitHubActions_flag
2222
# validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
2323
Linting:
@@ -58,7 +58,10 @@ SelectGitHubActions:
5858
# computed features
5959
AddLocalTests:
6060
type: bool
61-
default: "{{ 'AddLocalTests_flag' in SelectCodeQualityFeatures or 'AddGitHubActionBuild_flag' in SelectGitHubActions or 'AddSonarCloud_flag' in SelectCodeQualityFeatures }}"
61+
default: "{{
62+
'AddLocalTests_flag' in SelectCodeQualityFeatures
63+
or 'AddGitHubActionBuild_flag' in SelectGitHubActions
64+
or 'AddSonarCloud_flag' in SelectCodeQualityFeatures }}"
6265
when: false
6366
AddGitHubActionBuild:
6467
type: bool

copier/questions/features_documentation.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ SelectDocumentationFeatures:
1414
help: Select documentation features
1515
multiselect: true
1616
choices:
17-
Local documentation:
17+
Local documentation (using sphinx):
1818
value: AddLocalDocumentation_flag
1919
# validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
20-
Online documentation (Read the Docs):
20+
Online documentation (using Read the Docs):
2121
value: AddOnlineDocumentation_flag
2222
# validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
2323
Developer documentation:

copier/questions/features_publish_release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ SelectPublishReleaseFeatures:
1414
help: Select publish and release features
1515
multiselect: true
1616
choices:
17-
Citation (selection on the next menu):
17+
Citation (select in the next step):
1818
value: SelectCitation_flag
1919
# validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
2020
Changelog:

copier/questions/package_details.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,18 @@ package_short_description:
1818
keywords:
1919
type: str
2020
placeholder: keyword1,second keyword,third keyword
21-
help: Add keywords to make your package findable on PyPI
21+
help: Add keywords to make your package findable on PyPI (comma-separated)
2222
github_organization:
2323
type: str
24-
placeholder: "your-github-username or your-github-organization"
24+
placeholder: "your_github_username or your_github_organization"
2525
help: Enter the name of your GitHub username or organization
2626
validator: >-
2727
{% if not (github_organization | regex_search('^\\S*$')) %}
2828
Username or organization cannot include spaces
2929
{% endif %}
3030
email:
3131
type: str
32-
placeholder: yourname@esciencecenter.nl
32+
placeholder: yourname@universe.com
3333
help: What is your email address?
3434
validator: >-
3535
{% if not (email | regex_search('([A-Za-z0-9]+[.-_])*[A-Za-z0-9]+@[A-Za-z0-9-]+(\.[A-Z|a-z]{2,})+')) %}
@@ -38,7 +38,7 @@ email:
3838
copyright_holder:
3939
type: str
4040
default: "{{ full_name }}"
41-
help: Who is the copyright holder (the default is your full name)?
41+
help: "Who is the copyright holder (default: full name)?"
4242
validator: >-
4343
{% if not copyright_holder %}
4444
This field cannot be empty as it will be used in content of the generated files.

0 commit comments

Comments
 (0)