Repository: mesos Updated Branches: refs/heads/master 6cd28dd91 -> 4b591a0d0
Consistent capitalization of NOTE in Mardown style guide. Review: https://reviews.apache.org/r/35985 Project: http://git-wip-us.apache.org/repos/asf/mesos/repo Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/4b591a0d Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/4b591a0d Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/4b591a0d Branch: refs/heads/master Commit: 4b591a0d0925e1fe6ad37f4c72875428e16f8b9c Parents: 6cd28dd Author: Joerg Schad <[email protected]> Authored: Mon Jun 29 14:39:05 2015 +0200 Committer: Bernd Mathiske <[email protected]> Committed: Mon Jun 29 14:39:05 2015 +0200 ---------------------------------------------------------------------- docs/mesos-markdown-style-guide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mesos/blob/4b591a0d/docs/mesos-markdown-style-guide.md ---------------------------------------------------------------------- diff --git a/docs/mesos-markdown-style-guide.md b/docs/mesos-markdown-style-guide.md index d5b7804..fe9ffef 100644 --- a/docs/mesos-markdown-style-guide.md +++ b/docs/mesos-markdown-style-guide.md @@ -3,7 +3,7 @@ This guide introduces a consistent documentation style to be used across the entire non-code documentation. User guides and non-code technical documentation are stored in markdown files in the `docs/` folder. These files get rendered for the [online documentation](http://mesos.apache.org/documentation/latest/). -**Note:** As of right now this is work in progress and the existing documentation might not yet comply to this style. +**NOTE:** As of right now this is work in progress and the existing documentation might not yet comply to this style. ## What to document? @@ -30,14 +30,14 @@ Code examples should be specified as follows: } ~~~ -**NOTE**: Because of shortcomings of Doxygen's markdown parser we currently use indentation for wrapping all non C++ code blocks. +**NOTE:** Because of shortcomings of Doxygen's markdown parser we currently use indentation for wrapping all non C++ code blocks. ## Notes/Emphasis Notes are used to highlight important parts of the text and should be specified as follows. ~~~{.txt} -**Note:** Short note. +**NOTE:** Short note. Continued longer note. ~~~
