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

Don't hardwrap lines #959

Merged
merged 5 commits into from
Jul 8, 2024
Merged

Don't hardwrap lines #959

merged 5 commits into from
Jul 8, 2024

Conversation

peterdesmet
Copy link
Member

In most of the documentation, paragraphs are written on a single line in Markdown. I prefer this approach, as it is a clear rule for contributors and makes for easier diffs (in contrast, hardwraps require contributors to know what the wrap length should be).

So parts of the documentation had hardwrapped paragraphs. I have changed those to a single line. I did not make any other editorial changes.

@khusmann
Copy link
Contributor

khusmann commented Jul 2, 2024

If this is the style we want to enforce, we may want to set the proseWrap option in our .prettierrc.json to never. This will do a few things:

  1. When you save a file in an editor that supports prettier (like VSCode with prettier extension), all paragraphs will automatically be formatted on one line
  2. If a someone checks in a file that does not meet the prettier style check (e.g. if a paragraph is formatted on multiple lines), the CI check will fail (as it is currently doing)

Personally, I like hardwraps, because they make the file easier to navigate with VIM shortcuts. With proseWrap set to always, contributors don't ever need to check or change line widths manually because saving automatically reformats the doc with proper printWidth. But it's not a strong preference, I'm happy with anything as long as we're consistent and the style is automatically enforced with tools like prettier :)

Copy link
Member

@roll roll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @peterdesmet !

@roll roll merged commit e304cc0 into frictionlessdata:main Jul 8, 2024
1 check failed
@peterdesmet peterdesmet deleted the no-hardwrap branch July 8, 2024 08:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants