[ovs-dev] Markdown coding standard
Ben Pfaff
blp at nicira.com
Fri Feb 13 16:35:07 UTC 2015
On Thu, Feb 12, 2015 at 09:21:35PM +0100, Thomas Graf wrote:
> On 02/12/15 at 05:37pm, Finucane, Stephen wrote:
> > * Line limit? It's not necessary to wrap Markdown if you don't want to, but files seem to alternate between 72, 79 and 80+ quite a bit
>
> I basically did the minimum required to get quotes formatted correctly
> and didn't reformat everything. Cleanups are definitely welcome.
Just to add to this, I prefer to avoid lines longer than 79 characters.
> > * Any "expected approach" to validating Markdown output (i.e. confirm that it will preview correctly on GitHub)
>
> Personally I have been using Haroopad when changing the docs to verify
> correct rendering.
Maybe we should add a target to validate Markdown on builds, like we
have targets to check other invariants.
More information about the dev
mailing list