summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDimitrie Hoekstra <dimitrie@gitlab.com>2017-12-14 18:14:23 +0000
committerAchilleas Pipinellis <axil@gitlab.com>2017-12-14 18:14:23 +0000
commit7c20829c40644d01841bc086c36fd6942af59a39 (patch)
tree4bf904b2f85d127b73f08b2186f16f7f00de337b
parent8b33670e3144164637b22919ea58a69cea5dc38a (diff)
downloadgitlab-ce-7c20829c40644d01841bc086c36fd6942af59a39.tar.gz
clearer-documentation-on-inline-diffs
-rw-r--r--doc/user/markdown.md11
-rw-r--r--spec/fixtures/markdown.md.erb17
2 files changed, 25 insertions, 3 deletions
diff --git a/doc/user/markdown.md b/doc/user/markdown.md
index a671c92640a..552abac747b 100644
--- a/doc/user/markdown.md
+++ b/doc/user/markdown.md
@@ -195,12 +195,23 @@ With inline diffs tags you can display {+ additions +} or [- deletions -].
The wrapping tags can be either curly braces or square brackets [+ additions +] or {- deletions -}.
+Examples:
+
+```
+- {+ additions +}
+- [+ additions +]
+- {- deletions -}
+- [- deletions -]
+```
+
However the wrapping tags cannot be mixed as such:
+```
- {+ additions +]
- [+ additions +}
- {- deletions -]
- [- deletions -}
+```
### Emoji
diff --git a/spec/fixtures/markdown.md.erb b/spec/fixtures/markdown.md.erb
index 638cd8b07c8..71abb6da607 100644
--- a/spec/fixtures/markdown.md.erb
+++ b/spec/fixtures/markdown.md.erb
@@ -258,12 +258,23 @@ With inline diffs tags you can display {+ additions +} or [- deletions -].
The wrapping tags can be either curly braces or square brackets [+ additions +] or {- deletions -}.
-However the wrapping tags can not be mixed as such -
+Examples:
+```
+- {+ additions +}
+- [+ additions +]
+- {- deletions -}
+- [- deletions -]
+```
+
+However the wrapping tags cannot be mixed as such:
+
+```
- {+ additions +]
- [+ additions +}
-- {- delletions -]
-- [- delletions -}
+- {- deletions -]
+- [- deletions -}
+```
### Videos