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: comments are now more specific in code style. #964

Merged
merged 3 commits into from
Oct 21, 2023

Conversation

Jaskowicz1
Copy link
Contributor

This PR makes comments more specific in the code style, as it now has a demonstration of how we want comments, along with defining how general comments in a cpp should look (as we've have several cases of a mis-match in comment styles).

This PR also moves all the code from the coding style guide, into its own folder in example_code. This code isn't checked by the examples runner so it won't ever cause issues.

Documentation change checklist

  • My documentation changes follow the same style as the rest of the documentation and any examples follow the coding style guide.
  • I tested that my change works before raising the PR (via running doxygen, and testing examples).
  • I have not moved any existing pages or changed any existing URLs without strong justification as to why.
  • I have not generated content using AI or a desktop utility such as grammarly.

@Jaskowicz1 Jaskowicz1 self-assigned this Oct 21, 2023
@netlify
Copy link

netlify bot commented Oct 21, 2023

Deploy Preview for dpp-dev ready!

Name Link
🔨 Latest commit 022ec5d
🔍 Latest deploy log https://app.netlify.com/sites/dpp-dev/deploys/6533a08d20e83800082ad694
😎 Deploy Preview https://deploy-preview-964--dpp-dev.netlify.app/coding-standards
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 21, 2023
@braindigitalis braindigitalis merged commit af1af42 into brainboxdotcc:dev Oct 21, 2023
35 checks passed
@Jaskowicz1 Jaskowicz1 deleted the code-conv-changes branch November 13, 2023 22:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants