Update docs for using formatting targets to make it more obvious about helper format-check and format-apply targets #723
Conversation
This file contains hidden or 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
…t helper format-check and format-apply targets.
martygrant
force-pushed
the
martin/update-contrib-build-docs
branch
from
f1b8055 to
5ffb713
Compare
lukaszstolarczuk
approved these changes
Sep 12, 2024
bratpiorka
approved these changes
Sep 12, 2024
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.
Description
As a first time contributor it took a bit of hunting to find out why the
format-checkandformat-applytargets mentioned in the build docs were not working, a comment is hidden away inCMakeLists.txtsaying that all 3 of the formatters (clang-format,cmake-formatandblackneed to be installed before they are available. Updated build docs to try to make this a little more obvious.Checklist