From ebdb03b4d434aad3c23d2372e1eca63e4de4c4bd Mon Sep 17 00:00:00 2001 From: John Bampton Date: Wed, 5 Apr 2023 11:26:05 +1000 Subject: [PATCH] Fix grammar in `mruby-YOUR-bigint/TODO-HINT.md` --- examples/mrbgems/mruby-YOUR-bigint/TODO-HINT.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/mrbgems/mruby-YOUR-bigint/TODO-HINT.md b/examples/mrbgems/mruby-YOUR-bigint/TODO-HINT.md index 4027df969b..d1877f517d 100644 --- a/examples/mrbgems/mruby-YOUR-bigint/TODO-HINT.md +++ b/examples/mrbgems/mruby-YOUR-bigint/TODO-HINT.md @@ -10,7 +10,7 @@ The file structure in this example is as follows: +- mruby-YOUR-bigint/ <- Make this directory public if necessary. | Change the name of copied directory. | - +- TODO-HINT.md <- This file is currently viewing by you. + +- TODO-HINT.md <- You are currently viewing this file. | Remove this from copied directory. | +- core/ @@ -21,19 +21,19 @@ The file structure in this example is as follows: May be depended on by other GEMs. ``` -Implementors of own bigints should copy below this directory to another directory and do the following: +Implementors of their own bigints should copy below this directory to another directory and do the following: - Rewrite `spec.author`, `spec.license`, `spec.homepage` and `spec.summary` in `/mrbgem.rake` file to those of your own implementors. - Implement the respective functions in `/core/bigint.c`. - Define and use an object structure for `MRB_TT_BIGINT` type-tag. - It is recommended to use `mrb_static_assert_object_size()` to ensure that the size of the object structure is within 6 words. + It is recommended to use `mrb_static_assert_object_size()` to ensure that the size of the object structure is within six words. - Delete this file from the destination of the copy. If you wish to use it as an alternative to the `mruby-bigint` provided by mruby, please leave the GEM name in `/mrbgem.rake` as it is. This is an important factor when it is depended from other GEMs with `spec.add_dependency 'mruby-bigint'`. -The name of the top directory of GEM can be changed arbitrarily. -The name of the git repository can also be changed arbitrarily. +The name of the top directory of the GEM can be changed arbitrarily. +The name of the Git repository can also be changed arbitrarily. -Note that there is no need for an initialization function as there is in normal GEM. +Note that there is no need for an initialization function as there is in a normal GEM. If you need it, create a file `/src/bigint.c` for example, and implement the `mrb_mruby_bigint_gem_init()` function.