From db3774ea45ac85d4af32dc6d3d8ec0cdc3f8a722 Mon Sep 17 00:00:00 2001 From: John Bampton <418747+jbampton@users.noreply.github.com> Date: Sat, 6 May 2023 04:43:14 +1000 Subject: [PATCH] docs: fix links, grammar and spelling in Markdown --- README.md | 2 +- doc/guides/compile.md | 2 +- doc/guides/gc-arena-howto.md | 2 +- doc/guides/mrbgems.md | 2 +- doc/mruby3.0.md | 2 +- mrbgems/mruby-socket/README.md | 4 ++-- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 52a68b1d3..2b4902bde 100644 --- a/README.md +++ b/README.md @@ -114,4 +114,4 @@ To contribute to mruby, please refer to the [contribution guidelines][contributi By contributing, you grant non-exclusive rights to your code under the MIT License. [ISO-standard]: https://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=59579 -[contribution-guidelines]: https://github.com/mruby/mruby/blob/master/CONTRIBUTING.md +[contribution-guidelines]: CONTRIBUTING.md diff --git a/doc/guides/compile.md b/doc/guides/compile.md index 45730a26b..cc21c4d5c 100644 --- a/doc/guides/compile.md +++ b/doc/guides/compile.md @@ -265,7 +265,7 @@ There is a `RubyGem` (gem for CRuby) named `mgem` that help you to manage `mrbgems`. Try `gem install mgem`. `mgem` can show you the list of registered `mrbgems`. -See doc/mrbgems/README.md for more option about mrbgems. +See [doc/guides/mrbgems.md](mrbgems.md) for more option about mrbgems. ### Mrbtest diff --git a/doc/guides/gc-arena-howto.md b/doc/guides/gc-arena-howto.md index 22cd4ef1e..1701a79ff 100644 --- a/doc/guides/gc-arena-howto.md +++ b/doc/guides/gc-arena-howto.md @@ -62,7 +62,7 @@ memory leak. As of this writing, mruby automatically extend arena to remember objects (See `MRB_GC_FIXED_ARENA` and `MRB_GC_ARENA_SIZE` in -doc/guides/mrbconf.md). +[doc/guides/mrbconf.md](mrbconf.md)). If you create many objects in C functions, memory usage will increase, since GC never kicks in. This memory usage may look like memory leaks, but will also diff --git a/doc/guides/mrbgems.md b/doc/guides/mrbgems.md index 3f64fdf5d..c3b165bda 100644 --- a/doc/guides/mrbgems.md +++ b/doc/guides/mrbgems.md @@ -1,6 +1,6 @@ # mrbgems -mrbgems is a library manager to integrate C and Ruby extension in an easy and +mrbgems is a library manager to integrate C and Ruby extensions in an easy and standardised way into mruby. Conventionally, each mrbgem name is prefixed by `mruby-`, e.g. `mruby-time` for a gem that provides `Time` class functionality. diff --git a/doc/mruby3.0.md b/doc/mruby3.0.md index c1acb5ece..3f7418c49 100644 --- a/doc/mruby3.0.md +++ b/doc/mruby3.0.md @@ -159,4 +159,4 @@ For better and faster random number generation. Preallocated symbols are interned at compile-time. They can be accessed via symbols macros (e.g. `MRB_SYM()`). -See [Symbols](https://github.com/mruby/mruby/blob/master/doc/guides/symbol.md). +See [Symbols](guides/symbol.md). diff --git a/mrbgems/mruby-socket/README.md b/mrbgems/mruby-socket/README.md index f88ae3505..f7ff8ca32 100644 --- a/mrbgems/mruby-socket/README.md +++ b/mrbgems/mruby-socket/README.md @@ -20,8 +20,8 @@ Date: Tue, 21 May 2013 04:31:30 GMT ## Requirement -- [mruby-io](https://github.com/mruby/mruby/tree/master/mrbgems/mruby-io) mrbgem -- [iij/mruby-mtest](https://github.com/iij/mruby-mtest) mrgbem to run tests +- [mruby-io](../mruby-io) mrbgem +- [iij/mruby-mtest](https://github.com/iij/mruby-mtest) mrbgem to run tests - system must have RFC3493 basic socket interface - and some POSIX API...