Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lint name strings for… #2018

Open
6 tasks
ddbeck opened this issue Oct 21, 2024 · 2 comments
Open
6 tasks

Lint name strings for… #2018

ddbeck opened this issue Oct 21, 2024 · 2 comments
Labels
enhancement New feature or request tools and infrastructure Project internal tooling, such as linters, GitHub Actions, or repo settings

Comments

@ddbeck
Copy link
Collaborator

ddbeck commented Oct 21, 2024

We ought to check for style and consistency in name strings.

Some things we ought to check for:

  • Leading or trailing spaces
  • Markdown syntax (e.g., `code` or *emphasis*)
  • Balanced braces, brackets, and parentheses
  • Use of ellipses () and spaces
  • Uniqueness
  • Double (or more) spaces (e.g., Don't let this→ ←happen)

Prompted by #2017. Related to #1935.

@ddbeck ddbeck added enhancement New feature or request tools and infrastructure Project internal tooling, such as linters, GitHub Actions, or repo settings labels Oct 21, 2024
@captainbrosset
Copy link
Contributor

Other possible checks:

  • Check that <...> are balanced (e.g. no name with < but missing >).
  • The above could also be expanded to (...).
  • Check no other feature already has the exact same name.

@ddbeck
Copy link
Collaborator Author

ddbeck commented Oct 21, 2024

Good ideas. I added them to the checklist, plus a couple more for ellipses and double (or triple) white space characters.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request tools and infrastructure Project internal tooling, such as linters, GitHub Actions, or repo settings
Projects
None yet
Development

No branches or pull requests

2 participants