google / google/argh

Allow argument descriptions that begin with an uppercase letter

Open
#204 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
2k
Forks
102
PR merge metrics
No merged PRs in 30d

Description

Even if a particular prose style is encouraged, shouldn't there be a release valve available? (Or is there already?) Forcing all argument descriptions to start lowercase seems overly prescriptive to me, even for a library that describes itself as "opinionated". :)

For example, I'm not sure how to add multiple-sentence descriptions to arguments? Is the preferred way to just make everything lowercase, including the first character of the second sentence?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.