mesos-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Benjamin Bannier <benjamin.bann...@mesosphere.io>
Subject Re: Review Request 45033: Add a commit hook for checking non-ascii characters (MESOS-4033).
Date Fri, 01 Apr 2016 18:04:52 GMT


> On April 1, 2016, 6:53 p.m., Kevin Klues wrote:
> > As Neil said, I would also recommend *not* excluding the docs files. In the rare
case that we need non-ascii cahracters in the docs, we should use HTML character entities.
> > 
> > I would also not create a whole new python script for this.  It should be a simple
addition to the existing mesos-style.py script.

Shouldn't we switch to a markdown converter which can automatically translate unicode to HTML
entities (kramdown appears to be capable of this) instead of writing even  more markdown documentation
tailored to just one output format (here: HTML)? If we'd stick to clean markdown we might
even be able to generate documentation in different formats in the future (e.g., man pages
or info docs with Pandoc come to mind).

I filed MESOS-5077 so we can independently of the issues discussed here verify the validity
of generated HTML (something worth tackling on its own right), but I think a fix there might
well be able to address your and Neil's concerns expressed here.


- Benjamin


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


On March 23, 2016, 3:46 p.m., Yong Tang wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/45033/
> -----------------------------------------------------------
> 
> (Updated March 23, 2016, 3:46 p.m.)
> 
> 
> Review request for mesos, Alexander Rukletsov, Bernd Mathiske, haosdent huang, Neil Conway,
and Deshi Xiao.
> 
> 
> Bugs: MESOS-4033
>     https://issues.apache.org/jira/browse/MESOS-4033
> 
> 
> Repository: mesos
> 
> 
> Description
> -------
> 
> This review request tries to add a commit hook for checking non-ascii
> characters. It scans .cpp, .hpp, .cc, .h files and report
> error if non-ascii characters exists.
> 
> As part of this review request, two non-ascii characters are identified
> in versioning.md (one in Ln 85 and another in Ln 96) and are corrected
> accordingly.
> 
> Note: .md scan is skipped based on feedback from review request.
> 
> 
> Diffs
> -----
> 
>   docs/versioning.md ecacd8433f0fa1643827b36d03154042538c1c6b 
>   support/hooks/post-rewrite e3747a320fef0b71c06bcf0f2c5532958c416646 
>   support/hooks/pre-commit 10838a4c99db2a8318d64f95d90d2c2c90150453 
>   support/non-ascii.py PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/45033/diff/
> 
> 
> Testing
> -------
> 
> Tested manually and found two non ascii characters in docs/versioning.md (fixed as part
of this review request).
> 
> 
> Thanks,
> 
> Yong Tang
> 
>


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