[jira] [Commented] (MESOS-3786) Backticks are not mentioned in Mesos C++ Style Guide
[
https://issues.apache.org/jira/browse/MESOS-3786?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15019239#comment-15019239
]
Timothy Chen commented on MESOS-3786:
-
commit 7e81e50dfac7309b9d75040c353e40ebed2f2ae0
Author: Greg Mann
Date: Fri Nov 20 17:04:49 2015 -0800
Added backtick usage in comments to the C++ style guide.
Review: https://reviews.apache.org/r/40367
> Backticks are not mentioned in Mesos C++ Style Guide
>
>
> Key: MESOS-3786
> URL: https://issues.apache.org/jira/browse/MESOS-3786
> Project: Mesos
> Issue Type: Documentation
>Reporter: Greg Mann
>Assignee: Greg Mann
>Priority: Minor
> Labels: documentation, mesosphere
>
> As far as I can tell, current practice is to quote code excerpts and object
> names with backticks when writing comments. For example:
> {code}
> // You know, `sadPanda` seems extra sad lately.
> std::string sadPanda;
> sadPanda = " :'( ";
> {code}
> However, I don't see this documented in our C++ style guide at all. It should
> be added.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Commented] (MESOS-3786) Backticks are not mentioned in Mesos C++ Style Guide
[
https://issues.apache.org/jira/browse/MESOS-3786?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15007664#comment-15007664
]
Greg Mann commented on MESOS-3786:
--
Review here: https://reviews.apache.org/r/40367/
> Backticks are not mentioned in Mesos C++ Style Guide
>
>
> Key: MESOS-3786
> URL: https://issues.apache.org/jira/browse/MESOS-3786
> Project: Mesos
> Issue Type: Documentation
>Reporter: Greg Mann
>Assignee: Greg Mann
>Priority: Minor
> Labels: documentation, mesosphere
>
> As far as I can tell, current practice is to quote code excerpts and object
> names with backticks when writing comments. For example:
> {code}
> // You know, `sadPanda` seems extra sad lately.
> std::string sadPanda;
> sadPanda = " :'( ";
> {code}
> However, I don't see this documented in our C++ style guide at all. It should
> be added.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Commented] (MESOS-3786) Backticks are not mentioned in Mesos C++ Style Guide
[
https://issues.apache.org/jira/browse/MESOS-3786?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14971374#comment-14971374
]
Joseph Wu commented on MESOS-3786:
--
This was definitely intentional for the maintenance comments.
> Backticks are not mentioned in Mesos C++ Style Guide
>
>
> Key: MESOS-3786
> URL: https://issues.apache.org/jira/browse/MESOS-3786
> Project: Mesos
> Issue Type: Documentation
>Reporter: Greg Mann
>Assignee: Greg Mann
>Priority: Minor
> Labels: documentation, mesosphere
>
> As far as I can tell, current practice is to quote code excerpts and object
> names with backticks when writing comments. For example:
> {code}
> // You know, `sadPanda` seems extra sad lately.
> std::string sadPanda;
> sadPanda = " :'( ";
> {code}
> However, I don't see this documented in our C++ style guide at all. It should
> be added.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Commented] (MESOS-3786) Backticks are not mentioned in Mesos C++ Style Guide
[
https://issues.apache.org/jira/browse/MESOS-3786?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14968642#comment-14968642
]
Benjamin Bannier commented on MESOS-3786:
-
[~bmahler] Recent Doxygen (>=1.8.0) supports markdown and backticks cause
formatting as "code". I suspect this is what was intended in the instances you
refer to.
> Backticks are not mentioned in Mesos C++ Style Guide
>
>
> Key: MESOS-3786
> URL: https://issues.apache.org/jira/browse/MESOS-3786
> Project: Mesos
> Issue Type: Documentation
>Reporter: Greg Mann
>Assignee: Greg Mann
>Priority: Minor
> Labels: documentation, mesosphere
>
> As far as I can tell, current practice is to quote code excerpts and object
> names with backticks when writing comments. For example:
> {code}
> // You know, `sadPanda` seems extra sad lately.
> std::string sadPanda;
> sadPanda = " :'( ";
> {code}
> However, I don't see this documented in our C++ style guide at all. It should
> be added.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Commented] (MESOS-3786) Backticks are not mentioned in Mesos C++ Style Guide
[
https://issues.apache.org/jira/browse/MESOS-3786?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14968162#comment-14968162
]
Greg Mann commented on MESOS-3786:
--
Ah OK; I was under the impression that backticks were the way to go. In either
case, the correct convention should be documented in our style guide. Perhaps a
thread on the dev list would help folks come to consensus on a policy?
> Backticks are not mentioned in Mesos C++ Style Guide
>
>
> Key: MESOS-3786
> URL: https://issues.apache.org/jira/browse/MESOS-3786
> Project: Mesos
> Issue Type: Documentation
>Reporter: Greg Mann
>Assignee: Greg Mann
>Priority: Minor
> Labels: documentation, mesosphere
>
> As far as I can tell, current practice is to quote code excerpts and object
> names with backticks when writing comments. For example:
> {code}
> // You know, `sadPanda` seems extra sad lately.
> std::string sadPanda;
> sadPanda = " :'( ";
> {code}
> However, I don't see this documented in our C++ style guide at all. It should
> be added.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Commented] (MESOS-3786) Backticks are not mentioned in Mesos C++ Style Guide
[
https://issues.apache.org/jira/browse/MESOS-3786?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14968149#comment-14968149
]
Benjamin Mahler commented on MESOS-3786:
Ah.. should be single quotes for object names.
Looking through a grep, it looks like a number of recent patches introduced the
backticks: maintenance, systemd, fetcher cache, master json, and a couple of
others. Would be great to clean this up and prevent more backticks, but not a
big deal. Unless I'm missing something... e.g. in doxygen do backticks affect
rendering?
> Backticks are not mentioned in Mesos C++ Style Guide
>
>
> Key: MESOS-3786
> URL: https://issues.apache.org/jira/browse/MESOS-3786
> Project: Mesos
> Issue Type: Documentation
>Reporter: Greg Mann
>Assignee: Greg Mann
>Priority: Minor
> Labels: documentation, mesosphere
>
> As far as I can tell, current practice is to quote code excerpts and object
> names with backticks when writing comments. For example:
> {code}
> // You know, `sadPanda` seems extra sad lately.
> std::string sadPanda;
> sadPanda = " :'( ";
> {code}
> However, I don't see this documented in our C++ style guide at all. It should
> be added.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
