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

test-fixtures.md: Line-wrap code examples #2464

Merged
merged 2 commits into from Jun 19, 2022
Merged

Conversation

ferdnyc
Copy link
Contributor

@ferdnyc ferdnyc commented Jun 18, 2022

Description

Horizontal scrolling is the devil, particularly in documentation, and some of the code examples are formatted REALLY wide.

This documentation-only change line-wraps most of the examples in test-fixtures.md to fit within 80-100ish columns, as things like GitHub's formatted MarkDown renderer and most documentation site templates will struggle to fit anything wider into their page templates without the dreaded scrollbar appearing at the bottom of the block.

@codecov
Copy link

codecov bot commented Jun 18, 2022

Codecov Report

Merging #2464 (a710b25) into devel (165647a) will not change coverage.
The diff coverage is n/a.

❗ Current head a710b25 differs from pull request most recent head 6ebaa50. Consider uploading reports for the commit 6ebaa50 to get more accurate results

@@           Coverage Diff           @@
##            devel    #2464   +/-   ##
=======================================
  Coverage   91.49%   91.49%           
=======================================
  Files         159      159           
  Lines        7519     7519           
=======================================
  Hits         6879     6879           
  Misses        640      640           

docs/test-fixtures.md Outdated Show resolved Hide resolved
docs/test-fixtures.md Outdated Show resolved Hide resolved
docs/test-fixtures.md Outdated Show resolved Hide resolved
Copy link
Member

@horenmar horenmar left a comment

Choose a reason for hiding this comment

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

Sure, why not

docs/test-fixtures.md Outdated Show resolved Hide resolved
docs/test-fixtures.md Outdated Show resolved Hide resolved
@horenmar horenmar merged commit a369267 into catchorg:devel Jun 19, 2022
@ferdnyc ferdnyc deleted the patch-1 branch June 20, 2022 08:42
@ferdnyc
Copy link
Contributor Author

ferdnyc commented Jun 20, 2022

@horenmar

Sure, why not

Pretty sure that's actually more enthusiasm than I was expecting (occupational hazard of being a wikignome), so I'll take it! 😉

ferdnyc added a commit to ferdnyc/Catch2 that referenced this pull request Jun 20, 2022
* test-fixtures.md: Line-wrap code examples

* relinebreak

Co-authored-by: Martin Hořeňovský <martin.horenovsky@gmail.com>
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.

None yet

2 participants