From 61a2f3d2bf01ce02a74306abe730be49163ad457 Mon Sep 17 00:00:00 2001 From: wm4 Date: Sun, 25 May 2014 19:52:51 +0200 Subject: [PATCH] DOCS/coding-style: add a hint that new features should be documented --- DOCS/coding-style.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/DOCS/coding-style.md b/DOCS/coding-style.md index 45f838d06b..49411033f6 100644 --- a/DOCS/coding-style.md +++ b/DOCS/coding-style.md @@ -134,6 +134,8 @@ Sending patches Important: put an empty line between the subject line and the commit message. If this is missing, it will break display in common git tools. - Try to separate cosmetic and functional changes. It's ok to make a few - additional cosmetic changes in the same file you're working on, but don't do - something like reformatting a whole file and hiding an actual functional + additional cosmetic changes in the same file you're working on. But don't do + something like reformatting a whole file, and hiding an actual functional change in the same commit. +- If you add a new command line option, document it in options.rst. If you + add a new input property, document it in input.rst.