Skip to content

Update API reference #1160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

LaszloLango
Copy link
Contributor

JerryScript-DCO-1.0-Signed-off-by: László Langó [email protected]

@LaszloLango LaszloLango added enhancement An improvement api Related to the public API labels Jun 17, 2016
@LaszloLango LaszloLango added this to the Release v1.0 milestone Jun 17, 2016
```

- `script_source` - source code;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mention that it needs to be a valid utf8 string

@LaszloLango LaszloLango force-pushed the update-api-reference branch 2 times, most recently from dc7f919 to 75c897d Compare June 20, 2016 14:02
@LaszloLango LaszloLango mentioned this pull request Jun 22, 2016
13 tasks
- `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
Copy link
Member

@zherczeg zherczeg Jun 23, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"whether the"
and it seems the alignment below is strange

@zherczeg
Copy link
Member

After the minor changes, LGTM.

@LaszloLango LaszloLango force-pushed the update-api-reference branch from 75c897d to 536f442 Compare June 23, 2016 12:32
- `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
Copy link
Member

@dbatyai dbatyai Jun 24, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

run was performed feels a bit weird to me. Could we say something like completion code, indicating whether execution was successful?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I'll update them.

Create new JavaScript object, like with `new Object()`.

*Note*: Upon the JavaScript object becomes unused, all pointers to it should be released using
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

JerryScript-DCO-1.0-Signed-off-by: László Langó [email protected]
@LaszloLango LaszloLango force-pushed the update-api-reference branch from 536f442 to 388b442 Compare June 24, 2016 11:54
@LaszloLango
Copy link
Contributor Author

@zherczeg, @dbatyai, I've updated the PR.

@dbatyai
Copy link
Member

dbatyai commented Jun 24, 2016

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Related to the public API enhancement An improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants