Prefer cairo syntax highlighting in Markdown files #278
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andrew-fleming
approved these changes
Apr 19, 2022
There was a problem hiding this comment.
Hey @rootulp, thank you for submitting this PR! This looks great :) and you are correct, we used jsx because Cairo syntax highlighting wasn't available at the time of writing. I believe the Account and Security docs should also be updated. I'll make an issue for them if you'd like to tackle those as well. Thanks, again!
AbdelStark
added a commit
to AbdelStark/cairo-contracts
that referenced
this pull request
Apr 27, 2022
commit f96acc2 Author: Rootul Patel <rootulp@gmail.com> Date: Thu Apr 21 10:40:09 2022 -0400 More cairo syntax highlighting (OpenZeppelin#280) * More cairo syntax highlighting Fixes OpenZeppelin#279 Previously, code blocks used `c#` or `python` for syntax highlighting because `cairo` was not available. This change updates code blocks to use `cairo` now that it is available. The other changes were auto applied via markdownlint format on save. If reviewers request, they can be reverted. * Update README.md * Preserve colons after Returns and Accounts * Revert linter added newlines commit 9b4d6a3 Author: Rootul Patel <rootulp@gmail.com> Date: Tue Apr 19 15:19:45 2022 -0400 Prefer cairo syntax highlighting in Markdown files (OpenZeppelin#278) commit 270c76f Author: 0xSidius <100469911+0xSidius@users.noreply.github.com> Date: Tue Apr 19 03:00:08 2022 +0300 fix: change `initialized` visibility to `@view` (OpenZeppelin#276)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prior to this change, Cairo code blocks used
jsxsyntax highlighting which was less readable thancairosyntax highlighting. I suspect thatjsxwas used becausecairomay not have been available at the time of writing.The other changes were autofixed via markdown lint (trailing whitespace removal, consistent
-for bullets).