diff options
| author | John Bampton <[email protected]> | 2021-06-22 06:56:46 +1000 |
|---|---|---|
| committer | John Bampton <[email protected]> | 2021-06-22 06:57:03 +1000 |
| commit | 188e9b6fb01a8b228f4e4d7cce1d509e103f2610 (patch) | |
| tree | be30e63729f3ec039505b4b87a0ecded7e0bb9ed /doc | |
| parent | 8416e706ba1758e6d0f85adf0f2b3510ce711862 (diff) | |
| download | mruby-188e9b6fb01a8b228f4e4d7cce1d509e103f2610.tar.gz mruby-188e9b6fb01a8b228f4e4d7cce1d509e103f2610.zip | |
Enable markdownlint rules MD003,MD005,MD007
Lint Markdown
https://github.com/DavidAnson/markdownlint#rules--aliases
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guides/mrbgems.md | 6 | ||||
| -rw-r--r-- | doc/guides/symbol.md | 14 | ||||
| -rw-r--r-- | doc/mruby3.md | 3 |
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 |