summaryrefslogtreecommitdiffhomepage
path: root/doc/guides/gc-arena-howto.md
diff options
context:
space:
mode:
authorJohn Bampton <[email protected]>2021-04-11 12:51:28 +1000
committerYukihiro "Matz" Matsumoto <[email protected]>2021-04-16 16:37:52 +0900
commit9d32d440ebf1ebd0684f5349316a15602bea5421 (patch)
treeae119a76ef9922d77fd9d13efc095e0a746253ec /doc/guides/gc-arena-howto.md
parentac9038121bec0141b93c8751248ffdb7688b9474 (diff)
downloadmruby-9d32d440ebf1ebd0684f5349316a15602bea5421.tar.gz
mruby-9d32d440ebf1ebd0684f5349316a15602bea5421.zip
feat(CI): add the GitHub Super Linter
The GitHub Super Linter is a more robust and better supported tool than the current GitHub Actions we are using. Running these checks: ERROR_ON_MISSING_EXEC_BIT: true VALIDATE_BASH: true VALIDATE_BASH_EXEC: true VALIDATE_EDITORCONFIG: true VALIDATE_MARKDOWN: true VALIDATE_SHELL_SHFMT: true VALIDATE_YAML: true https://github.com/marketplace/actions/super-linter https://github.com/github/super-linter Added the GitHub Super Linter badge to the README. Also updated the pre-commit framework and added more documentation on pre-commit. Added one more pre-commit check: check-executables-have-shebangs Added one extra check for merge conflicts to our GitHub Actions. EditorConfig and Markdown linting. Minor grammar and spelling fixes. Update linter.yml
Diffstat (limited to 'doc/guides/gc-arena-howto.md')
-rw-r--r--doc/guides/gc-arena-howto.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/guides/gc-arena-howto.md b/doc/guides/gc-arena-howto.md
index 192a10802..2c1cdc1fb 100644
--- a/doc/guides/gc-arena-howto.md
+++ b/doc/guides/gc-arena-howto.md
@@ -3,7 +3,7 @@
_This is an English translation of [Matz's blog post][matz blog post]
written in Japanese._
_Some parts are updated to reflect recent changes._
-[matz blog post]: https://www.rubyist.net/~matz/20130731.html
+[matz blog post]: <https://www.rubyist.net/~matz/20130731.html>
When you are extending mruby using C language, you may encounter
mysterious "arena overflow error" or memory leak or very slow
@@ -46,7 +46,7 @@ no longer referenced in the Ruby world, and cannot be treated as garbage.
In mruby, we recognize all objects created in C function are alive.
Then we have no problem such as confusing a live object as dead.
-This means that because we cannot collect truly dead object, we may
+This means that because we cannot collect a truly dead object, we may
lose efficiency, but as a trade-off the GC itself is highly portable.
We can say goodbye to the problem that GC deletes live objects due to
optimization which sometimes occurs in CRuby.
@@ -140,7 +140,7 @@ inspect_ary(mrb_state *mrb, mrb_value ary, mrb_value list)
}
```
-This is a real example, so a little bit complicated, but bear with me.
+This is a real example, so slightly complicated, but bear with me.
The essence of `Array#inspect` is that after stringifying each element
of array using `inspect` method, we join them together so that we can
get `inspect` representation of the entire array.