summaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorYukihiro "Matz" Matsumoto <[email protected]>2021-06-22 13:14:34 +0900
committerGitHub <[email protected]>2021-06-22 13:14:34 +0900
commitfc6210763ca6c440e1992700df07948fe6ae97b4 (patch)
treedcf2c86e4d9673c388ef5539130394767b415ee0 /doc
parent40ca240c4cd863f9be2ca9a00cffdb1443750453 (diff)
parent188e9b6fb01a8b228f4e4d7cce1d509e103f2610 (diff)
downloadmruby-fc6210763ca6c440e1992700df07948fe6ae97b4.tar.gz
mruby-fc6210763ca6c440e1992700df07948fe6ae97b4.zip
Merge pull request #5487 from jbampton/lint-markdown
Enable markdownlint rules MD003,MD005,MD007
Diffstat (limited to 'doc')
-rw-r--r--doc/guides/mrbgems.md6
-rw-r--r--doc/guides/symbol.md14
-rw-r--r--doc/mruby3.md3
3 files changed, 11 insertions, 12 deletions
diff --git a/doc/guides/mrbgems.md b/doc/guides/mrbgems.md
index e67a260d1..c08a09f4e 100644
--- a/doc/guides/mrbgems.md
+++ b/doc/guides/mrbgems.md
@@ -200,8 +200,8 @@ Version requirement supports following operators:
* '>=': is equal or greater
* '<=': is equal or lesser
* '~>': is equal or greater and is lesser than the next major version
- * example 1: '~> 2.2.2' means '>= 2.2.2' and '< 2.3.0'
- * example 2: '~> 2.2' means '>= 2.2.0' and '< 3.0.0'
+ * example 1: '~> 2.2.2' means '>= 2.2.2' and '< 2.3.0'
+ * example 2: '~> 2.2' means '>= 2.2.0' and '< 3.0.0'
When more than one version requirements is passed, the dependency must satisfy all of it.
@@ -215,7 +215,7 @@ use `MRuby::Build#gem` in the build configuration to override default gem.
If you have conflicting GEMs use the following method:
* `spec.add_conflict(gem, *requirements)`
- * The `requirements` argument is same as in `add_dependency` method.
+ * The `requirements` argument is same as in `add_dependency` method.
like following code:
diff --git a/doc/guides/symbol.md b/doc/guides/symbol.md
index 5ce8cdd4d..8f90ce59f 100644
--- a/doc/guides/symbol.md
+++ b/doc/guides/symbol.md
@@ -57,13 +57,13 @@ To save RAM, `mruby` can use compile-time allocation of some symbols. You can
use following macros to get preallocated symbols by including `mruby/presym.h`
header.
- * `MRB_SYM(xor)` //=> xor (Word characters)
- * `MRB_SYM_B(xor)` //=> xor! (Method with Bang)
- * `MRB_SYM_Q(xor)` //=> xor? (Method with Question mark)
- * `MRB_SYM_E(xor)` //=> xor= (Method with Equal)
- * `MRB_CVSYM(xor)` //=> @@xor (Class Variable)
- * `MRB_IVSYM(xor)` //=> @xor (Instance Variable)
- * `MRB_OPSYM(xor)` //=> ^ (Operator)
+* `MRB_SYM(xor)` //=> xor (Word characters)
+* `MRB_SYM_B(xor)` //=> xor! (Method with Bang)
+* `MRB_SYM_Q(xor)` //=> xor? (Method with Question mark)
+* `MRB_SYM_E(xor)` //=> xor= (Method with Equal)
+* `MRB_CVSYM(xor)` //=> @@xor (Class Variable)
+* `MRB_IVSYM(xor)` //=> @xor (Instance Variable)
+* `MRB_OPSYM(xor)` //=> ^ (Operator)
For `MRB_OPSYM()`, specify the names corresponding to operators (see
`MRuby::Presym::OPERATORS` in `lib/mruby/presym.rb` for the names that
diff --git a/doc/mruby3.md b/doc/mruby3.md
index cf103e428..c5da856d1 100644
--- a/doc/mruby3.md
+++ b/doc/mruby3.md
@@ -1,5 +1,4 @@
-User visible changes in `mruby3`
-===
+# User visible changes in `mruby3`
# Build System