Update API reference #1160
Merged
Update API reference #1160
Conversation
This file contains hidden or 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
docs/API-REFERENCE.md
Outdated
| jerry_flag_t flags); | ||
| ``` | ||
| - `script_source` - source code; |
Member
There was a problem hiding this comment.
mention that it needs to be a valid utf8 string
LaszloLango
force-pushed
the
update-api-reference
branch
2 times, most recently
from
dc7f919 to
75c897d
Compare
docs/API-REFERENCE.md
Outdated
| - `script_source` - source code, it must be a valid utf8 string. | ||
| - `script_source_size` - size of source code buffer, in bytes. | ||
| - return value - completion code that indicates whether run was performed |
Member
There was a problem hiding this comment.
"whether the"
and it seems the alignment below is strange
Member
|
After the minor changes, LGTM. |
LaszloLango
force-pushed
the
update-api-reference
branch
from
75c897d to
536f442
Compare
docs/API-REFERENCE.md
Outdated
| - `script_source` - source code, it must be a valid utf8 string. | ||
| - `script_source_size` - size of source code buffer, in bytes. | ||
| - return value - completion code that indicates whether the run was performed successfully |
Member
There was a problem hiding this comment.
run was performed feels a bit weird to me. Could we say something like completion code, indicating whether execution was successful?
Contributor
Author
There was a problem hiding this comment.
Sure, I'll update them.
docs/API-REFERENCE.md
Outdated
|
|
||
| Create new JavaScript object, like with `new Object()`. | ||
|
|
||
| *Note*: Upon the JavaScript object becomes unused, all pointers to it should be released using |
JerryScript-DCO-1.0-Signed-off-by: László Langó llango.u-szeged@partner.samsung.com
LaszloLango
force-pushed
the
update-api-reference
branch
from
536f442 to
388b442
Compare
Contributor
Author
Member
|
LGTM |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
JerryScript-DCO-1.0-Signed-off-by: László Langó llango.u-szeged@partner.samsung.com