summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2014-05-25 19:52:51 +0200
committerwm4 <wm4@nowhere>2014-06-14 13:47:38 +0200
commit61a2f3d2bf01ce02a74306abe730be49163ad457 (patch)
treebbbad4edcc217fd6457370503a6f05ebdfc34cc3
parent213ea94ee34f05562bd5df188bac1400e7ea7822 (diff)
downloadmpv-61a2f3d2bf01ce02a74306abe730be49163ad457.tar.bz2
mpv-61a2f3d2bf01ce02a74306abe730be49163ad457.tar.xz
DOCS/coding-style: add a hint that new features should be documented
-rw-r--r--DOCS/coding-style.md6
1 files 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.