Skip to content

checks: allow for multi-line code blocks#2060

Closed
jorgeorpinel wants to merge 3 commits into
masterfrom
prettier/proseWrap-preserve
Closed

checks: allow for multi-line code blocks#2060
jorgeorpinel wants to merge 3 commits into
masterfrom
prettier/proseWrap-preserve

Conversation

@jorgeorpinel
Copy link
Copy Markdown
Contributor

per #2054 (review)

You may disregard these recommendations if you used the Edit on GitHub button from dvc.org to improve a doc in place.

❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.

🐛 Please make sure to mention Fix #issue (if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.

Please choose to allow us to edit your branch when creating the PR.

Thank you for the contribution - we'll try to review it as soon as possible. 🙏

@jorgeorpinel
Copy link
Copy Markdown
Contributor Author

I ran yarn format-all after the prettier config change and this is what happened. Waiting for test app deployment to double check the rendered results... ⌛

Comment thread content/blog/2020-04-06-april-20-dvc-heartbeat.md Outdated
@shcheklein
Copy link
Copy Markdown
Contributor

I still don't quite understand what does this change exactly mean

@jorgeorpinel jorgeorpinel had a problem deploying to dvc-landing-prettier-pr-tsp8dp December 28, 2020 01:57 Failure
@jorgeorpinel
Copy link
Copy Markdown
Contributor Author

jorgeorpinel commented Dec 28, 2020

@shcheklein per https://prettier.io/docs/en/options.html#prose-wrap this means to "wrap markdown text as-is" (which BTW is the default behavior). So we should rather see why it was set to "always" (which means "wrap if it exceeds the print width").

I guess it's about auto-breaking long lines... So perhaps you're right that this might have big implications...

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-prettier-pr-tsp8dp December 28, 2020 02:08 Inactive
Copy link
Copy Markdown
Contributor Author

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

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

Yeah with this change regular long lines in md don't get wrapped 🤦

Comment thread .prettierrc
"printWidth": 80,
"tabWidth": 2,
"useTabs": false,
"proseWrap": "always"
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

("preserve" is the default value anyway.)

- performance.json
training:
desc: Training stage description
desc: Training stage description blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Long line in code block

`dvc.yaml` files consists of a group of `stages` with names provided explicitly
by the user with the `--name` (`-n`) option of `dvc run`. Each stage can contain
the following fields:
the following fields blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah:
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Long line in md

@jorgeorpinel
Copy link
Copy Markdown
Contributor Author

Ivan was right!

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.

2 participants