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

docs: Added syntax highlighting to README #2384

Merged
merged 1 commit into from Apr 16, 2024

Conversation

LF3551
Copy link
Contributor

@LF3551 LF3551 commented Apr 16, 2024

Thank you for considering my Pull Request. I have noticed that our README lacks syntax highlighting in code blocks, which can make it slightly harder to read. To address this issue, I have added appropriate syntax highlighting annotations to the code blocks in the README. This small change could improve the readability and overall look of the documentation.

Here’s what I’ve done in this PR:

  • Added bash for shell scripts and batch for Batch file segments in the README to enable syntax highlighting.
  • Checked all code blocks to ensure they are now properly highlighted according to their context.

Fixes #2364 🦕

@LF3551 LF3551 requested a review from a team as a code owner April 16, 2024 12:51
Copy link

google-cla bot commented Apr 16, 2024

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@product-auto-label product-auto-label bot added the size: xs Pull request size is extra small. label Apr 16, 2024
Copy link

conventional-commit-lint-gcf bot commented Apr 16, 2024

🤖 I detect that the PR title and the commit message differ and there's only one commit. To use the PR title for the commit history, you can use Github's automerge feature with squashing, or use automerge label. Good luck human!

-- conventional-commit-lint bot
https://conventionalcommits.org/

@parthea parthea changed the title Added syntax highlighting to README docs: Added syntax highlighting to README Apr 16, 2024
Copy link
Contributor

@parthea parthea left a comment

Choose a reason for hiding this comment

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

Thanks @LF3551!

@parthea parthea enabled auto-merge (squash) April 16, 2024 14:05
@parthea parthea added kokoro:force-run Add this label to force Kokoro to re-run the tests. kokoro:run Add this label to force Kokoro to re-run the tests. owlbot:run Add this label to trigger the Owlbot post processor. labels Apr 16, 2024
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Apr 16, 2024
@yoshi-kokoro yoshi-kokoro removed kokoro:run Add this label to force Kokoro to re-run the tests. kokoro:force-run Add this label to force Kokoro to re-run the tests. labels Apr 16, 2024
@parthea parthea merged commit 1f27614 into googleapis:main Apr 16, 2024
13 checks passed
@LF3551 LF3551 deleted the readme-changes-16-04-2024 branch April 16, 2024 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: xs Pull request size is extra small.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Highlight code syntax in the readme file for better visibility
3 participants