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

[rfc] streamline module structure #1373

Open
Nytelife26 opened this issue May 28, 2024 · 0 comments
Open

[rfc] streamline module structure #1373

Nytelife26 opened this issue May 28, 2024 · 0 comments
Assignees
Labels
cat: rfc Issues that propose changes, or a Request For Comments.

Comments

@Nytelife26
Copy link
Member

Nytelife26 commented May 28, 2024

this is a follow up of #1362, and intends to address issues previously raised in #1155.

Out of scope considerations: cursing, security, links. Each has merits, but they feel out of place in the context of the goal of proselint.

Current plan:

  • all checks with one file will be flattened by putting the check file itself into the root directory and renaming it to the category name, both for startup performance ([rfc] startup overhead reduction #1374) and tidiness reasons.
  • airlinese, bureaucratese, chatspeak, commercialese, corporate_speak, jargon will all be merged into a new category titled industrial_language (this name is open for discussion)
  • security, links, and cursing (except for cursing.nword, see below) will be removed
  • sexism, lgbtq, and cursing.nword will be merged into a new category (the name is currently undecided, but may become social_awareness)
  • punctuation.spacing will be recategorised under typography, because spacing is a purely typographic matter
  • typography.exclamation and hyperbole will be recategorised under punctuation, merging into punctuation.hyperbole for consistency

Condensing considerations:

  • mondegreens and malapropisms are commonly grouped together in analysis

A check naming standard will be formed, and referenced in contributing guidelines.

@Nytelife26 Nytelife26 added the cat: rfc Issues that propose changes, or a Request For Comments. label May 28, 2024
@Nytelife26 Nytelife26 self-assigned this May 28, 2024
@Nytelife26 Nytelife26 pinned this issue May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cat: rfc Issues that propose changes, or a Request For Comments.
Projects
None yet
Development

No branches or pull requests

1 participant