Skip to content
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.

Sign up for GitHub

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

Jump to bottom

API docs improvements #942

Merged
merged 27 commits into from
Feb 3, 2023
Merged

API docs improvements #942

merged 27 commits into from
Feb 3, 2023

Conversation

dherman
Copy link
Collaborator

@dherman dherman commented Nov 14, 2022 •
edited
Loading

Improvements to API docs:

  • Align wording for all neon::types doc summaries.
  • Examples for all neon::types types.
    • JsArray
    • JsBoolean
    • JsDate
    • JsError
    • JsFunction
    • JsFuture
    • JsNull
    • JsNumber
    • JsObject
    • JsPromise
    • JsString
    • JsUndefined
    • JsValue
Main neon::types page before: API docs page before
Main neon::types page after: API docs page after

@kjvalencik kjvalencik mentioned this pull request Nov 15, 2022
Merged
@dherman dherman marked this pull request as ready for review January 9, 2023 23:53
kjvalencik
kjvalencik requested changes Jan 10, 2023
View reviewed changes
crates/neon/Cargo.toml Show resolved Hide resolved
crates/neon/src/types_impl/boxed.rs Outdated Show resolved Hide resolved
crates/neon/src/types_impl/buffer/types.rs Show resolved Hide resolved
crates/neon/src/types_impl/date.rs Outdated Show resolved Hide resolved
crates/neon/src/types_impl/error.rs Show resolved Hide resolved
crates/neon/src/types_impl/mod.rs Show resolved Hide resolved
crates/neon/src/types_impl/promise.rs Outdated Show resolved Hide resolved
crates/neon/src/types_impl/promise.rs Outdated Show resolved Hide resolved
crates/neon/src/types_impl/promise.rs Show resolved Hide resolved
crates/neon/src/types_impl/promise.rs Show resolved Hide resolved
dherman and others added 7 commits January 23, 2023 09:42
@dherman @kjvalencik
copy edit: "type of JS smart pointer" -> "JS smart pointer"
6686822 
Co-authored-by: K.J. Valencik <kjvalencik@gmail.com>
@dherman @kjvalencik
Simplification for Date example code
7904f1b 
Co-authored-by: K.J. Valencik <kjvalencik@gmail.com>
@dherman @kjvalencik
Simplify example with call_method_with
cdd8cc8 
Co-authored-by: K.J. Valencik <kjvalencik@gmail.com>
@dherman @kjvalencik
Simplify another example with call_method_with
1f332d6 
Co-authored-by: K.J. Valencik <kjvalencik@gmail.com>
@dherman @kjvalencik
Add "see also" reference from exec to call_with.
3945cba 
Co-authored-by: K.J. Valencik <kjvalencik@gmail.com>
@dherman
Clarifying copy
e0055bd
@dherman
Explain the role of Deferred in the Promise docs
4e35241
@dherman dherman merged commit 3b149e3 into main Feb 3, 2023
@dherman dherman deleted the apidoc-examples branch February 3, 2023 17:21
@dherman dherman mentioned this pull request Feb 3, 2023
Closed
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kjvalencik kjvalencik kjvalencik approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dherman @kjvalencik