Fix: Reduce proselint warnings #1966
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dunglas
requested changes
Sep 18, 2024
core/bootstrap.md
Outdated
| @@ -559,7 +559,7 @@ $list->insert($itemNormalizer, -895); | |||
| // $list->insert($uuidDenormalizer, -895); //Todo ramsey uuid support ? | |||
| $list->insert($openApiNormalizer, -780); | |||
|
|
|||
| // TODO: JSON-API support | |||
| // Todo: JSON-API support | |||
There was a problem hiding this comment.
Can you revert this one please? This syntax in "normal"
There was a problem hiding this comment.
Happy to do so, and I wholly agree this is normal syntax, just proselint doesn't agree, removed the commit entirely + rebased.
```lint ./extra/releases.md: - dates_times.dates When specifying a month and year, no comma is needed. ```
```lint weasel_words.very Substitute 'damn' every time you're inclined to write 'very'; your editor will delete it and the writing will be just as it should be. ```
pieterocp
force-pushed
the
3.3-fix-proselint
branch
from
240a5e3
to
a55d22c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This addresses all the easily addressable proselint-able issues (on the basis that if there is a tool linting, getting it down to zero or as close to makes any increase jump out). I've gone with a marked version over main as this is a bug fix? Not sure.
The three remaining are a bit on the fiddly side:
First one is completely fine to the best of my knowledge, or the removal of
fully-featuredmight work as an alternative?Second is the whitespace in the dns section, I do not know enough about DNS records and their creation to know if the removal of a single whitespace to appease a prose linter would still make the guide still work, so I have not touched it.
Third is a link to symfony docs, where the it's the section title which would need "fixing", but this is a url, should a prose tool be reading URLs - maybe they will stop validating URLs over this.
Addition: With respect to the third, we might want to switch to a different tool than Proselint given the lack of updates.