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: update README.md of examples-clang-format #161

Merged
merged 1 commit into from
Jan 2, 2025

Conversation

lumirlumir
Copy link
Owner

This pull request includes updates to the examples/clang-format/README.md file to improve clarity and provide more comprehensive instructions for running the example. The most important changes include renaming the example, restructuring the instructions, and expanding the list of commands.

Improvements to documentation:

  • Renamed the example from clang-format to examples-clang-format for consistency.
  • Restructured the instructions by adding a "Getting Started" section and separating the methods for running the example into "Run from the Root" and "Navigate to the Directory and Run" sections.
  • Expanded the list of available commands to include all variations of formatted and unformatted commands for both C and C++ languages.

@github-actions github-actions bot added the docs label Jan 2, 2025
Copy link

github-actions bot commented Jan 2, 2025

Labels have been automatically applied based on the conventional commit types.🏷️

Copy link

codecov bot commented Jan 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (fcf1129) to head (efbe6c2).
Report is 1 commits behind head on main.

@@            Coverage Diff            @@
##              main      #161   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           11        11           
  Lines          416       416           
=========================================
  Hits           416       416           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fcf1129...efbe6c2. Read the comment docs.

@lumirlumir lumirlumir merged commit db5fd70 into main Jan 2, 2025
6 checks passed
@lumirlumir lumirlumir deleted the docs-update-examples-clang-format-readme branch January 2, 2025 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant