Enums and docs update #77
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mat-hek
requested changes
Jul 29, 2021
pages/creating_unifex_natives.md
Outdated
Comment on lines
95
to
108
| Elixir type | Native type | ||
| --- | --- | ||
| `atom` | `char *` | ||
| `bool` | `int` | ||
| `float` | `double` | ||
| `int` | `int` | ||
| `int64` | `int64_t` | ||
| `payload` | `UnifexPayload` | ||
| `pid` | `UnifexPid` | ||
| `state` | `UnifexState *` | ||
| `string` | `char *` | ||
| `uint64` | `uint64_t` | ||
| `unsigned` | `unsigned int` | ||
| `[int]` | `int *`, `unsigned int` |
There was a problem hiding this comment.
I think this list should rather be a part of documentation, not the tutorial
pages/creating_unifex_natives.md
Outdated
| @@ -80,12 +80,100 @@ UNIFEX_TERM foo(UnifexEnv* env, int num) { | |||
| return foo_result_ok(env, num); | |||
| } | |||
| ``` | |||
| You can see, that we used function `foo_result_ok` in the implementation above. For every tuple, that might be returned from our Unifex function (in this case, it is `foo`), there will be generated implementation of result function named `[orginal_function_name]_result_[label]`, where `label` is atom with type `label` in returned tuple. Type of the first argument of this function will be `UnifexEnv*`, number and types of the rest of the arguments will depend on number and types of rest of elements in the returned tuple (see the table below). | |||
|
|
|||
| It is a very simple C code that always returns the same number it gets. | |||
There was a problem hiding this comment.
since you put a paragraph above, that sentence sounds weird
pages/creating_unifex_natives.md
Outdated
| @@ -80,12 +80,100 @@ UNIFEX_TERM foo(UnifexEnv* env, int num) { | |||
| return foo_result_ok(env, num); | |||
| } | |||
| ``` | |||
| You can see, that we used function `foo_result_ok` in the implementation above. For every tuple, that might be returned from our Unifex function (in this case, it is `foo`), there will be generated implementation of result function named `[orginal_function_name]_result_[label]`, where `label` is atom with type `label` in returned tuple. Type of the first argument of this function will be `UnifexEnv*`, number and types of the rest of the arguments will depend on number and types of rest of elements in the returned tuple (see the table below). | |||
There was a problem hiding this comment.
Suggested change
| You can see, that we used function `foo_result_ok` in the implementation above. For every tuple, that might be returned from our Unifex function (in this case, it is `foo`), there will be generated implementation of result function named `[orginal_function_name]_result_[label]`, where `label` is atom with type `label` in returned tuple. Type of the first argument of this function will be `UnifexEnv*`, number and types of the rest of the arguments will depend on number and types of rest of elements in the returned tuple (see the table below). | |
| As you can see, we used function `foo_result_ok` in the implementation above. For every tuple, that might be returned from our Unifex function (in this case, it is `foo`), there will be generated implementation of result function named `[orginal_function_name]_result_[label]`, where `label` is an atom with type `label` in returned tuple. The type of the first argument of this function will be `UnifexEnv*`, number and types of the rest of the arguments will depend on the number and types of rest of elements in the returned tuple (see the table below). |
Please use Grammarly to verify English.
FelonEkonom
force-pushed
the
enums-update
branch
from
efe59ab to
04c64cc
Compare
mat-hek
approved these changes
Aug 17, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.