Skip to content

Commit 188e9b6

Browse files
jbamptonjbampton
committed
Enable markdownlint rules MD003,MD005,MD007
Lint Markdown https://github.com/DavidAnson/markdownlint#rules--aliases
1 parent 8416e70 commit 188e9b6

File tree

9 files changed

+44
-59
lines changed

9 files changed

+44
-59
lines changed

‎.github/linters/.markdown-lint.yml‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,6 @@
44
# MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time
55
MD001: false
66

7-
# MD003 heading-style/header-style - Heading style
8-
MD003: false
9-
10-
# MD005 list-indent - Inconsistent indentation for list items at the same level
11-
MD005: false
12-
13-
# MD007 ul-indent - Unordered list indentation
14-
MD007: false
15-
167
# MD010 no-hard-tabs - Hard tabs
178
MD010: false
189

‎TODO.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Thing to Do in the future
2-
===
1+
# Thing to Do in the future
32

43
# After mruby 3.0
54

‎doc/guides/mrbgems.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -200,8 +200,8 @@ Version requirement supports following operators:
200200
* '>=': is equal or greater
201201
* '<=': is equal or lesser
202202
* '~>': is equal or greater and is lesser than the next major version
203-
* example 1: '~> 2.2.2' means '>= 2.2.2' and '< 2.3.0'
204-
* example 2: '~> 2.2' means '>= 2.2.0' and '< 3.0.0'
203+
* example 1: '~> 2.2.2' means '>= 2.2.2' and '< 2.3.0'
204+
* example 2: '~> 2.2' means '>= 2.2.0' and '< 3.0.0'
205205

206206
When more than one version requirements is passed, the dependency must satisfy all of it.
207207

@@ -215,7 +215,7 @@ use `MRuby::Build#gem` in the build configuration to override default gem.
215215
If you have conflicting GEMs use the following method:
216216

217217
* `spec.add_conflict(gem, *requirements)`
218-
* The `requirements` argument is same as in `add_dependency` method.
218+
* The `requirements` argument is same as in `add_dependency` method.
219219

220220
like following code:
221221

‎doc/guides/symbol.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,13 @@ To save RAM, `mruby` can use compile-time allocation of some symbols. You can
5757
use following macros to get preallocated symbols by including `mruby/presym.h`
5858
header.
5959

60-
* `MRB_SYM(xor)` //=> xor (Word characters)
61-
* `MRB_SYM_B(xor)` //=> xor! (Method with Bang)
62-
* `MRB_SYM_Q(xor)` //=> xor? (Method with Question mark)
63-
* `MRB_SYM_E(xor)` //=> xor= (Method with Equal)
64-
* `MRB_CVSYM(xor)` //=> @@xor (Class Variable)
65-
* `MRB_IVSYM(xor)` //=> @xor (Instance Variable)
66-
* `MRB_OPSYM(xor)` //=> ^ (Operator)
60+
* `MRB_SYM(xor)` //=> xor (Word characters)
61+
* `MRB_SYM_B(xor)` //=> xor! (Method with Bang)
62+
* `MRB_SYM_Q(xor)` //=> xor? (Method with Question mark)
63+
* `MRB_SYM_E(xor)` //=> xor= (Method with Equal)
64+
* `MRB_CVSYM(xor)` //=> @@xor (Class Variable)
65+
* `MRB_IVSYM(xor)` //=> @xor (Instance Variable)
66+
* `MRB_OPSYM(xor)` //=> ^ (Operator)
6767

6868
For `MRB_OPSYM()`, specify the names corresponding to operators (see
6969
`MRuby::Presym::OPERATORS` in `lib/mruby/presym.rb` for the names that

‎doc/mruby3.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
User visible changes in `mruby3`
2-
===
1+
# User visible changes in `mruby3`
32

43
# Build System
54

‎mrbgems/mruby-io/README.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
mruby-io
2-
========
1+
# mruby-io
32

43
`IO` and `File` classes for mruby
54

‎mrbgems/mruby-method/README.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
mruby-method
2-
===
1+
# mruby-method
32

43
An implementation of class **Method** and **UnboundMethod** for mruby
54

‎mrbgems/mruby-pack/README.md‎

Lines changed: 29 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
mruby-pack (pack / unpack)
2-
=========
1+
# mruby-pack (pack / unpack)
32

43
mruby-pack provides `Array#pack` and `String#unpack` for mruby.
54

@@ -15,34 +14,34 @@ There is no dependency on other mrbgems.
1514

1615
## Supported template string
1716

18-
- A : arbitrary binary string (space padded, count is width)
19-
- a : arbitrary binary string (null padded, count is width)
20-
- C : 8-bit unsigned (unsigned char)
21-
- c : 8-bit signed (signed char)
22-
- D, d: 64-bit float, native format
23-
- E : 64-bit float, little endian byte order
24-
- e : 32-bit float, little endian byte order
25-
- F, f: 32-bit float, native format
26-
- G : 64-bit float, network (big-endian) byte order
27-
- g : 32-bit float, network (big-endian) byte order
28-
- H : hex string (high nibble first)
29-
- h : hex string (low nibble first)
30-
- I : unsigned integer, native endian (`unsigned int` in C)
31-
- i : signed integer, native endian (`int` in C)
32-
- L : 32-bit unsigned, native endian (`uint32_t`)
33-
- l : 32-bit signed, native endian (`int32_t`)
34-
- m : base64 encoded string (see RFC 2045, count is width)
35-
- N : 32-bit unsigned, network (big-endian) byte order
36-
- n : 16-bit unsigned, network (big-endian) byte order
37-
- Q : 64-bit unsigned, native endian (`uint64_t`)
38-
- q : 64-bit signed, native endian (`int64_t`)
39-
- S : 16-bit unsigned, native endian (`uint16_t`)
40-
- s : 16-bit signed, native endian (`int16_t`)
41-
- U : UTF-8 character
42-
- V : 32-bit unsigned, VAX (little-endian) byte order
43-
- v : 16-bit unsigned, VAX (little-endian) byte order
44-
- x : null byte
45-
- Z : same as "a", except that null is added with *
17+
- A : arbitrary binary string (space padded, count is width)
18+
- a : arbitrary binary string (null padded, count is width)
19+
- C : 8-bit unsigned (unsigned char)
20+
- c : 8-bit signed (signed char)
21+
- D, d: 64-bit float, native format
22+
- E : 64-bit float, little endian byte order
23+
- e : 32-bit float, little endian byte order
24+
- F, f: 32-bit float, native format
25+
- G : 64-bit float, network (big-endian) byte order
26+
- g : 32-bit float, network (big-endian) byte order
27+
- H : hex string (high nibble first)
28+
- h : hex string (low nibble first)
29+
- I : unsigned integer, native endian (`unsigned int` in C)
30+
- i : signed integer, native endian (`int` in C)
31+
- L : 32-bit unsigned, native endian (`uint32_t`)
32+
- l : 32-bit signed, native endian (`int32_t`)
33+
- m : base64 encoded string (see RFC 2045, count is width)
34+
- N : 32-bit unsigned, network (big-endian) byte order
35+
- n : 16-bit unsigned, network (big-endian) byte order
36+
- Q : 64-bit unsigned, native endian (`uint64_t`)
37+
- q : 64-bit signed, native endian (`int64_t`)
38+
- S : 16-bit unsigned, native endian (`uint16_t`)
39+
- s : 16-bit signed, native endian (`int16_t`)
40+
- U : UTF-8 character
41+
- V : 32-bit unsigned, VAX (little-endian) byte order
42+
- v : 16-bit unsigned, VAX (little-endian) byte order
43+
- x : null byte
44+
- Z : same as "a", except that null is added with *
4645

4746
## License
4847

‎mrbgems/mruby-socket/README.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
mruby-socket
2-
============
1+
# mruby-socket
32

43
"mruby-socket" mrbgem provides BSD socket interface for mruby.
54
API is compatible with CRuby's "socket" library.

0 commit comments

Comments
 (0)