-
-
Notifications
You must be signed in to change notification settings - Fork 84
Open
Labels
status: blockedWaiting for something else to be resolvedWaiting for something else to be resolvedtype: featureNew enhancement or requestNew enhancement or request
Description
Feature Request Checklist
- I have pulled the latest
main
branch of the repository. - I have searched for related issues and found none that matched my issue.
Overview
Coming over from JoshuaKGoldberg/eslint-plugin-package-json#998 (comment): @michaelfaith brings up a good point that the "one sentence per line" enforcement currently implemented as a Markdownlint rule -https://github.com/JoshuaKGoldberg/sentences-per-line- is really more of a formatter concern.
Summarizing my interpretation (did I read it correctly?):
- The biggest priority is encouraging folks to write docs, since that's often an afterthought & tough ask
- The inconvenience of having a not-often-configured-by-default tool, especially a linter, conflicts with that priority
- The net benefit of keeping to one sentence per line in docs is arguably lesser than the net cost of that inconvenience
Additional Info
I actually have been meaning to rework the other Prettier plugins used in this repo:
- prettier-ignore handling with prettier-plugin-curly buggyย prettier/prettier#16951
- ๐ Bug: prettier plugin collisionย prettier-plugin-curly#386
...but haven't had the time to really buckle down and figure out how to refactor, say, prettier-plugin-curly
to the "right" way of doing things. Once that's figured out I think it'd be good to write a prettier-plugin-sentences-per-line
or something like that.
Co-authored-by: @michaelfaith
๐
lishaduck and ajitzeromichaelfaith and lishaduck
Metadata
Metadata
Assignees
Labels
status: blockedWaiting for something else to be resolvedWaiting for something else to be resolvedtype: featureNew enhancement or requestNew enhancement or request