add ability to split md into code snippets, check with cpplint #597
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Hi,
this PR will split the core guidelines files into snippets, to be able to run further tools on these snippets to ensure quality.
As a first step, I added a cpplint to this PR, which travis will perform.
cpplint originates at Google (https://github.com/google/styleguide) but is not really maintained there anymore. It's a very bad linter based on regular expressions (meaning several false positives and negatives can easily be produced forcefully), a very far shot from Facebooks Infer. But it's small and lightweight, and get's things right 90% of the time.
Anyway, I have been using it in the past to make PRs to improve code style here, and I think by now it should be possible to include it in the travis build. It should fail for this PR right now, because of the latest code example additions, but that suits me fine, that way you can judge whether you'd lke to have such a tool in the Pull request validation or not.
To run locally, the only dependency it adds to running
makeis to have a python installed (2 or 3).