docs: use unix line-endings for markdown files#1144
Conversation
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
📝 WalkthroughWalkthroughThe pull request standardizes line endings across markdown documentation by adding a Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
huff0/README.md (1)
43-43: Minor typo: "some of there" → "some of these".While touching this file, you might consider fixing this pre-existing grammar error.
📝 Suggested fix
-As can be seen above some of there are errors that will be returned even under normal operation so it is important to handle these. +As can be seen above some of these are errors that will be returned even under normal operation so it is important to handle these.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@huff0/README.md` at line 43, Typo in README.md: replace "some of there are errors" with "some of these are errors" (or rephrase to "some of these errors will be returned") in the sentence that currently reads "As can be seen above some of there are errors that will be returned even under normal operation so it is important to handle these." to correct grammar and optionally add commas for clarity.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@huff0/README.md`:
- Line 43: Typo in README.md: replace "some of there are errors" with "some of
these are errors" (or rephrase to "some of these errors will be returned") in
the sentence that currently reads "As can be seen above some of there are errors
that will be returned even under normal operation so it is important to handle
these." to correct grammar and optionally add commas for clarity.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 2f872549-63ef-4bee-bbd8-54cc6530c57e
📒 Files selected for processing (5)
.gitattributesREADME.mddict/README.mdfse/README.mdhuff0/README.md
What do you mean? |
|
Maybe @maxcleme recalls the exact details (it's in one of our internal repositories, where I noticed an extra job was added to fix line endings). |
|
I should add that in general, vendored files should always be considered "opaque", so not sure if that job should be there in the first place, but I think LF is more commonly used for Markdown, so thought it was worth opening a pull request for consideration 😅. |
|
We had vendoring issue in the past with dependabot PR when tied to windows-specific dependencies that forced us to use the following as a workaround: - name: Convert files in vendor folder to Unix format
run: |
find vendor -type f -print0 | xargs -0 dos2unixAfter a quick search, looks like it is already reported but not fixed yet. dependabot/dependabot-core#8693 |
|
Thanks! |
We noticed some churn in our CI where files ended up with the wrong line endings; opening this PR for consideration (I realise it's a large amount of "lines" changed, but hopefully a one-time rip of the bandaid is OK).
Summary by CodeRabbit
.gitattributesrule to standardize markdown file line endings.