Copyedit and fix textual and formatting errors in SDG form #9
Conversation
CAM-Gerlach
force-pushed
the
copyedit-sdg-template
branch
from
810fef3 to
c66e7ce
Compare
| description: >- | ||
| "Who will implement this, what's the timeline, how will it be done" | ||
| description: "Who will implement this, what's the timeline, and how will it be carried out" |
There was a problem hiding this comment.
Fixes the spurious quotes in the block scalar here being unintentionally displayed in the output
| validations: | ||
| required: true | ||
| - id: amount | ||
| type: input | ||
| attributes: | ||
| label: Amount requested | ||
| description: How much money is required to execute this proposal | ||
| description: "How much money is required to execute this proposal (max $10k)" |
There was a problem hiding this comment.
May as well be explict about the limit
| placeholder: "First name & Last name" | ||
| label: Submitter | ||
| description: "Who is submitting this request" | ||
| placeholder: "Full name" |
There was a problem hiding this comment.
Avoid embedding the assumption that the ordering or structure of the submitter's name conforms to Western cultural norms
| value: | | ||
| Complete the below fields to submit a Small Development Grant proposal. | ||
| Note that a project lead has to approve the proposal submission. | ||
| > [!IMPORTANT] |
There was a problem hiding this comment.
Use a more appropriate and less negative admonition type here
| Complete the below fields to submit a Small Development Grant proposal. | ||
| Note that a project lead has to approve the proposal submission. |
There was a problem hiding this comment.
Use clearer and more appropriate wording
| labels: | ||
| - Awaiting approval | ||
| body: | ||
| - id: instructions | ||
| type: markdown | ||
| attributes: | ||
| value: |+ |
There was a problem hiding this comment.
No obvious need to specify not normalizing trailing newlines (of which there is only the one anyway)
| description: >- | ||
| What will be the imapct to the community if this project gets funded | ||
| description: "How will this proposal positively impact the community" |
There was a problem hiding this comment.
Simplified and clarified this phrasing to be more direct and less awkward/unidiomatic. Also fixed a typo.
| description: Which project is this proposal for? Comma separate them if this is a collaboration between different projects. | ||
| description: "Which NumFOCUS project is this proposal for (comma separate the names if a collaboration between multiple projects)" |
There was a problem hiding this comment.
Was removing the question mark intentional?
This fixes a number of basic typos, textual errors/issues (grammar, wording, phrasing, clarity), and formatting errors/inconsistencies (wording, quoting, capitalization, YAML syntax) in the SDG template, in addition to a light copyedit for clarity and correctness.
General fixes:
descriptionentriesSee PR comments for brief explanations of some specific changes.