ARROW-5341: [C++][Documentation] developers/cpp.rst should mention documentation warnings#4578
Closed
bkietz wants to merge 2 commits intoapache:masterfrom
Closed
ARROW-5341: [C++][Documentation] developers/cpp.rst should mention documentation warnings#4578bkietz wants to merge 2 commits intoapache:masterfrom
bkietz wants to merge 2 commits intoapache:masterfrom
Conversation
wesm
reviewed
Jun 14, 2019
docs/source/developers/cpp.rst
Outdated
| Additionally, when using ``CHECKIN`` and compiling with ``clang`` | ||
| `documentation warnings | ||
| <https://releases.llvm.org/7.0.1/tools/clang/docs/DiagnosticsReference.html#wdocumentation>`_ | ||
| will be issued and cause build failure. |
Member
There was a problem hiding this comment.
I'm going to make some more changes to this and add a dedicated section about Doxygen comments
fsaintjacques
changed the title
wesm
changed the title
Codecov Report
@@ Coverage Diff @@
## master #4578 +/- ##
=========================================
Coverage ? 65.09%
=========================================
Files ? 478
Lines ? 61739
Branches ? 0
=========================================
Hits ? 40192
Misses ? 21547
Partials ? 0Continue to review full report at Codecov.
|
Member
|
+1. thanks @bkietz for helping out with the docs! |
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
3 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.
Add a section detailing that documentation warnings will break the build at level
CHECKINwith the clang compiler. The relevant clang documentation is linked so that readers can look up what might provoke a doc warning