carpentries / carpentries/instructor-training
Check use of quotes/italics/bold for consistency
- Dominant language
- No language data
- Stars
- 189
- Forks
- 301
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 7
Description
### How could the content be improved?
Per review from @brownsarahm on #1778 it's not clear or consistent when **bold** is used, when *italics* is used, or when "double quotes" are used to emphasize or set aside words and phrases. A clear plan should be created in consultation with @carpentries/core-team-curriculum as to what is best to use when, then the lesson should be checked for consistency with the policy and necessary changes made throughout.
For example from previous review of:
>### Encourage a Growth Mindset
> People vary in their beliefs about the nature of intelligence and skill development. In academic environments, people
>are often praised as *talented* or having *high ability*, and may develop an identity around being a certain "type of
@brownsarahm commented:
>again, i am not sure about the choice to swap quotes to italics, pair programming and talking stick I am very much on the fence (I might even think that those two should actually be links only, no additional formatting), and am happy to defer, but I think "talented" and "high ability" are in quotes to indicate that these are not values that we hold but are things that other people often say.
>at a minimum, I am confidence that "talented", "high ability" and "type of person" should be treated the same in this sentence so alternative to my suggestion is to swap " to * on type of person.
Contributor guide
Research direction
Start with the “Encourage a Growth Mindset” lesson passage and review the discussion in issue #1778. Consult @carpentries/core-team-curriculum to establish the formatting policy, then check the lesson for consistent treatment of bold, italics, and quotes throughout; done means the policy is agreed and the lesson follows it.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100