mesos-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Marco Massenzio" <ma...@mesosphere.io>
Subject Re: Review Request 36193: Improved Doxygen-Styleguide.
Date Mon, 06 Jul 2015 21:24:39 GMT


> On July 6, 2015, 6:06 p.m., Joseph Wu wrote:
> > Can you comment on the use of the `@copydoc` tag?
> > I used it in the associated review (36141), but it isn't mentioned in the Doxygen
style guide.

I am somewhat hesitant about us trying to "whitelist" *everything* that is allowed.
I much prefer Google's approach of "if it's not forbidden, and is not obviously wrong, it
should be allowed"

The risk is to having then to maintain huge (and expanding) list of "allowed" stuff, and people
having to memorize them - ideally, one should have the general guidelines, as the ones here;
a set of "blacklisted" features (brief and automated checks); and then a general freedom to
use whatever is not forbidden.

Trying to codify every little thing tends to stifle creativity and is not something we should
strive for, IMHO.


- Marco


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/36193/#review90515
-----------------------------------------------------------


On July 6, 2015, 9:01 a.m., Joerg Schad wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/36193/
> -----------------------------------------------------------
> 
> (Updated July 6, 2015, 9:01 a.m.)
> 
> 
> Review request for mesos, Benjamin Hindman, Bernd Mathiske, and Joseph Wu.
> 
> 
> Repository: mesos
> 
> 
> Description
> -------
> 
> Improved Doxygen-Styleguide for clarifying discussions arising from https://reviews.apache.org/r/36141/.
> 
> 
> Diffs
> -----
> 
>   docs/mesos-doxygen-style-guide.md 72156c72fc40f72740e57d47d0436c60f6d05bd7 
> 
> Diff: https://reviews.apache.org/r/36193/diff/
> 
> 
> Testing
> -------
> 
> Checked rendered markdown.
> 
> 
> Thanks,
> 
> Joerg Schad
> 
>


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message