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.

Sign up for GitHub

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

Jump to bottom

Update environment file with clang-format and cppcheck and update docs #2310

Merged
merged 6 commits into from
Mar 15, 2022
Merged

Update environment file with clang-format and cppcheck and update docs #2310

merged 6 commits into from
Mar 15, 2022

Conversation

jessica-mitchell
Copy link
Contributor

This PR adds clang-format-9 and cppcheck to the list of tools in the environment.yml file
It also updates the documentation regarding C++ guidelines:

  • The install instructions for the tools are completely removed in favour of suggesting using the environment file to do installations (note that in PR Update installation pages for Read the docs #2288 additional changes will be made to installation instructions)
  • The instructions on running the checks is put into a separate file, as the guidelines are already quite long.

Resolves #2271

@jessica-mitchell jessica-mitchell added I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. labels Feb 23, 2022
@jessica-mitchell jessica-mitchell added this to In progress in Documentation via automation Feb 23, 2022
terhorstd
terhorstd approved these changes Mar 15, 2022
View reviewed changes
Copy link
Contributor

@terhorstd terhorstd left a comment

Choose a reason for hiding this comment

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

Major overhaul in progress anyway. This is one of the steps in the right direction. More will follow.
👍

Documentation automation moved this from In progress to Review Mar 15, 2022
@terhorstd terhorstd merged commit 60e3e35 into nest:master Mar 15, 2022
Documentation automation moved this from Review to Done Mar 15, 2022
@jessica-mitchell jessica-mitchell deleted the update-conda-env branch April 17, 2024 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@terhorstd terhorstd terhorstd approved these changes

Assignees
No one assigned
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Documentation
  
Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add tools to developer environment
2 participants
@jessica-mitchell @terhorstd