Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

make descriptions less surprising #227

Merged
merged 4 commits into from
Jun 25, 2022
Merged

Conversation

davidjgoss
Copy link
Contributor

@davidjgoss davidjgoss commented Jun 24, 2022

🤔 What's changed?

Use remark-breaks to mimic the behaviour of GitHub comments etc where single line breaks are honoured without requiring an escape or double space.

⚡️ What's your motivation?

Fixes #225

🏷️ What kind of change is this?

  • ⚡ New feature (non-breaking change which adds new behaviour)

📋 Checklist:

  • I agree to respect and uphold the Cucumber Community Code of Conduct
  • I've changed the behaviour of the code
    • I have added/updated tests to cover my changes.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
  • Users should know about my change
    • I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

This text was originally generated from a template, then edited by hand. You can modify the template here.

Copy link
Contributor

@olleolleolle olleolleolle left a comment

Choose a reason for hiding this comment

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

Super-nice change, well-packaged. The remarkPlugins collection is neat.

@davidjgoss davidjgoss merged commit ded525b into main Jun 25, 2022
@davidjgoss davidjgoss deleted the feat/description-soft-breaks branch June 25, 2022 07:39
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Markdown rendering of description can be surprising
2 participants