summaryrefslogtreecommitdiff
path: root/doc/development/gotchas.md
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2017-02-16 14:42:40 +0100
committerAchilleas Pipinellis <axilleas@axilleas.me>2017-02-16 14:42:40 +0100
commitd603cf2f3956057fa3e1416367b59ae146d0c1a3 (patch)
tree6e92830873ee2eb5c3c420c5448973b578262eb8 /doc/development/gotchas.md
parentedecab2041c1be24f430bc4ab6615116273b6659 (diff)
downloadgitlab-ce-d603cf2f3956057fa3e1416367b59ae146d0c1a3.tar.gz
Do not use single quote in headings as it breaks docs.gitlab.com
[ci skip]
Diffstat (limited to 'doc/development/gotchas.md')
-rw-r--r--doc/development/gotchas.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/development/gotchas.md b/doc/development/gotchas.md
index 0f78e8238af..565d4b33457 100644
--- a/doc/development/gotchas.md
+++ b/doc/development/gotchas.md
@@ -3,7 +3,7 @@
The purpose of this guide is to document potential "gotchas" that contributors
might encounter or should avoid during development of GitLab CE and EE.
-## Don't `describe` symbols
+## Do not `describe` symbols
Consider the following model spec:
@@ -32,7 +32,7 @@ spec/models/user_spec.rb|6 error| Failure/Error: u = described_class.new NoMeth
Except for the top-level `describe` block, always provide a String argument to
`describe`.
-## Don't assert against the absolute value of a sequence-generated attribute
+## Do not assert against the absolute value of a sequence-generated attribute
Consider the following factory:
@@ -121,7 +121,7 @@ describe API::Labels do
end
```
-## Don't `rescue Exception`
+## Do not `rescue Exception`
See ["Why is it bad style to `rescue Exception => e` in Ruby?"][Exception].
@@ -130,7 +130,7 @@ Rubocop](https://gitlab.com/gitlab-org/gitlab-ce/blob/8-4-stable/.rubocop.yml#L9
[Exception]: http://stackoverflow.com/q/10048173/223897
-## Don't use inline JavaScript in views
+## Do not use inline JavaScript in views
Using the inline `:javascript` Haml filters comes with a
performance overhead. Using inline JavaScript is not a good way to structure your code and should be avoided.