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

Updated Ruby code block markdown syntax #1447

Merged
merged 1 commit into from
Jan 29, 2024
Merged

Updated Ruby code block markdown syntax #1447

merged 1 commit into from
Jan 29, 2024

Conversation

threeplanetssoftware
Copy link
Contributor

Submitted per #1446

This pull request updates the feature and Markdown files to have the Ruby code blocks be recognized as such. In the feature files, the code block was indented one too far and so it appears to have been taken as part of quoted text. On the README files, the code blocks weren't delineated at all.

Running rake tests after this change showed no differences in Cucumbers output, but the Middleman display now shows proper code blocks.

… in proper markdown. De-indented the markdown specifying code blocks on feature files by one level to be recognized as such.
@pirj
Copy link
Member

pirj commented Jan 29, 2024

Thank you!
As far as I remember, we publish docs for a released version, manually. So once we have a minor version, we’ll publish this.

Similar PRs to other repos are much appreciated.

@pirj pirj merged commit 96a3e5a into rspec:main Jan 29, 2024
29 of 30 checks passed
@threeplanetssoftware
Copy link
Contributor Author

Similar PRs to other repos are much appreciated.

From my initial look, this repo had the most corrections. I'm poking at the others as well to make sure of that. Thanks!

JonRowe pushed a commit that referenced this pull request Feb 4, 2024
…on-code-blocks

Updated Ruby code block markdown syntax
@JonRowe
Copy link
Member

JonRowe commented Feb 4, 2024

These have been published, they don't change the output though because our syntax highlighting on features at least don't support the extra information I guess

@threeplanetssoftware
Copy link
Contributor Author

Actually, it did! I still have a copy of the code from before the changes were pushed and this is what the front page of rspec-expectations 3.12 used to look like:
image

As of this morning, syntax highlighting works:
image

Thank you for pushing these changes live! Have a great day,

@pirj
Copy link
Member

pirj commented Feb 5, 2024

Looks great with highlighting !
I think Jon meant that feature files don’t get highlighted. But the markdown ones surely are.

I’ve noticed an increased indentation in your screenshot.

Thanks for all the hard work, @threeplanetssoftware . I know, our docs are not easy to improve.

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

3 participants