Commit 188e9b6f authored by John Bampton's avatar John Bampton

Enable markdownlint rules MD003,MD005,MD007

Lint Markdown

https://github.com/DavidAnson/markdownlint#rules--aliases
parent 8416e706
...@@ -4,15 +4,6 @@ ...@@ -4,15 +4,6 @@
# MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time # MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time
MD001: false MD001: false
# MD003 heading-style/header-style - Heading style
MD003: false
# MD005 list-indent - Inconsistent indentation for list items at the same level
MD005: false
# MD007 ul-indent - Unordered list indentation
MD007: false
# MD010 no-hard-tabs - Hard tabs # MD010 no-hard-tabs - Hard tabs
MD010: false MD010: false
......
Thing to Do in the future # Thing to Do in the future
===
# After mruby 3.0 # After mruby 3.0
......
...@@ -200,8 +200,8 @@ Version requirement supports following operators: ...@@ -200,8 +200,8 @@ Version requirement supports following operators:
* '>=': is equal or greater * '>=': is equal or greater
* '<=': is equal or lesser * '<=': is equal or lesser
* '~>': is equal or greater and is lesser than the next major version * '~>': 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 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 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. 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. ...@@ -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: If you have conflicting GEMs use the following method:
* `spec.add_conflict(gem, *requirements)` * `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: like following code:
......
...@@ -57,13 +57,13 @@ To save RAM, `mruby` can use compile-time allocation of some symbols. You can ...@@ -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` use following macros to get preallocated symbols by including `mruby/presym.h`
header. header.
* `MRB_SYM(xor)` //=> xor (Word characters) * `MRB_SYM(xor)` //=> xor (Word characters)
* `MRB_SYM_B(xor)` //=> xor! (Method with Bang) * `MRB_SYM_B(xor)` //=> xor! (Method with Bang)
* `MRB_SYM_Q(xor)` //=> xor? (Method with Question mark) * `MRB_SYM_Q(xor)` //=> xor? (Method with Question mark)
* `MRB_SYM_E(xor)` //=> xor= (Method with Equal) * `MRB_SYM_E(xor)` //=> xor= (Method with Equal)
* `MRB_CVSYM(xor)` //=> @@xor (Class Variable) * `MRB_CVSYM(xor)` //=> @@xor (Class Variable)
* `MRB_IVSYM(xor)` //=> @xor (Instance Variable) * `MRB_IVSYM(xor)` //=> @xor (Instance Variable)
* `MRB_OPSYM(xor)` //=> ^ (Operator) * `MRB_OPSYM(xor)` //=> ^ (Operator)
For `MRB_OPSYM()`, specify the names corresponding to operators (see For `MRB_OPSYM()`, specify the names corresponding to operators (see
`MRuby::Presym::OPERATORS` in `lib/mruby/presym.rb` for the names that `MRuby::Presym::OPERATORS` in `lib/mruby/presym.rb` for the names that
......
User visible changes in `mruby3` # User visible changes in `mruby3`
===
# Build System # Build System
......
mruby-io # mruby-io
========
`IO` and `File` classes for mruby `IO` and `File` classes for mruby
......
mruby-method # mruby-method
===
An implementation of class **Method** and **UnboundMethod** for mruby An implementation of class **Method** and **UnboundMethod** for mruby
......
mruby-pack (pack / unpack) # mruby-pack (pack / unpack)
=========
mruby-pack provides `Array#pack` and `String#unpack` for mruby. mruby-pack provides `Array#pack` and `String#unpack` for mruby.
...@@ -15,34 +14,34 @@ There is no dependency on other mrbgems. ...@@ -15,34 +14,34 @@ There is no dependency on other mrbgems.
## Supported template string ## Supported template string
- A : arbitrary binary string (space padded, count is width) - A : arbitrary binary string (space padded, count is width)
- a : arbitrary binary string (null padded, count is width) - a : arbitrary binary string (null padded, count is width)
- C : 8-bit unsigned (unsigned char) - C : 8-bit unsigned (unsigned char)
- c : 8-bit signed (signed char) - c : 8-bit signed (signed char)
- D, d: 64-bit float, native format - D, d: 64-bit float, native format
- E : 64-bit float, little endian byte order - E : 64-bit float, little endian byte order
- e : 32-bit float, little endian byte order - e : 32-bit float, little endian byte order
- F, f: 32-bit float, native format - F, f: 32-bit float, native format
- G : 64-bit float, network (big-endian) byte order - G : 64-bit float, network (big-endian) byte order
- g : 32-bit float, network (big-endian) byte order - g : 32-bit float, network (big-endian) byte order
- H : hex string (high nibble first) - H : hex string (high nibble first)
- h : hex string (low nibble first) - h : hex string (low nibble first)
- I : unsigned integer, native endian (`unsigned int` in C) - I : unsigned integer, native endian (`unsigned int` in C)
- i : signed integer, native endian (`int` in C) - i : signed integer, native endian (`int` in C)
- L : 32-bit unsigned, native endian (`uint32_t`) - L : 32-bit unsigned, native endian (`uint32_t`)
- l : 32-bit signed, native endian (`int32_t`) - l : 32-bit signed, native endian (`int32_t`)
- m : base64 encoded string (see RFC 2045, count is width) - m : base64 encoded string (see RFC 2045, count is width)
- N : 32-bit unsigned, network (big-endian) byte order - N : 32-bit unsigned, network (big-endian) byte order
- n : 16-bit unsigned, network (big-endian) byte order - n : 16-bit unsigned, network (big-endian) byte order
- Q : 64-bit unsigned, native endian (`uint64_t`) - Q : 64-bit unsigned, native endian (`uint64_t`)
- q : 64-bit signed, native endian (`int64_t`) - q : 64-bit signed, native endian (`int64_t`)
- S : 16-bit unsigned, native endian (`uint16_t`) - S : 16-bit unsigned, native endian (`uint16_t`)
- s : 16-bit signed, native endian (`int16_t`) - s : 16-bit signed, native endian (`int16_t`)
- U : UTF-8 character - U : UTF-8 character
- V : 32-bit unsigned, VAX (little-endian) byte order - V : 32-bit unsigned, VAX (little-endian) byte order
- v : 16-bit unsigned, VAX (little-endian) byte order - v : 16-bit unsigned, VAX (little-endian) byte order
- x : null byte - x : null byte
- Z : same as "a", except that null is added with * - Z : same as "a", except that null is added with *
## License ## License
......
mruby-socket # mruby-socket
============
"mruby-socket" mrbgem provides BSD socket interface for mruby. "mruby-socket" mrbgem provides BSD socket interface for mruby.
API is compatible with CRuby's "socket" library. API is compatible with CRuby's "socket" library.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment