Skip to content

Minor doc fixes#426

Closed
bmacnaughton wants to merge 2 commits intonodejs:masterfrom
bmacnaughton:minor-doc-fixes
Closed

Minor doc fixes#426
bmacnaughton wants to merge 2 commits intonodejs:masterfrom
bmacnaughton:minor-doc-fixes

Conversation

@bmacnaughton
Copy link
Copy Markdown
Contributor

@bmacnaughton bmacnaughton commented Jan 10, 2019

As I was working through the docs I made edits when I noticed typos, misspellings, or in the case of object.md, incorrect information.

I find myself doing a bit more research than I wanted to in a few cases and wondered what your thoughts were on expanding some of the docs to include examples as opposed to (mostly just) API.

Here's a list of items that I found myself experimenting with to get something working because I couldn't deduce from the docs alone what I needed to do.

  • external data
  • DefineClass examples for Instance/Static methods/properties
  • property_descriptors
  • how to use class_property_descriptors

(actually I didn't get the last two working and just found a way around the issue but those were my first approaches.)

If you're open to providing more examples for the first two let me know where you think they belong and I'll work on some.

Thanks for the excellent doc. When I compare this to trying to get Nan working over a year ago it's night and day.

@bmacnaughton
doc/ - minor doc corrections and clarifications
53b60e7 
- class_property_descriptor - Contructor => Constructor
- number - Nuber => Number
- object - returns *undefined* not NULL if key doesn't exist
- object_wrap - Contructor => Constructor
- property_descriptor - environemnt => environment
@bmacnaughton
tools/README - minor corrections
a0479a7 
- associated => associates
- add a
@mhdawson
Copy link
Copy Markdown
Member

mhdawson commented Jan 10, 2019

We are definitely open to adding more examples info to help clarify the concepts. Will need a bit more time to take a look to see where they might go. @NickNaso might also have some suggestions.

mhdawson
mhdawson approved these changes Jan 10, 2019
View reviewed changes
Copy link
Copy Markdown
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for making our docs better!

NickNaso
NickNaso approved these changes Jan 10, 2019
View reviewed changes
Copy link
Copy Markdown
Member

@NickNaso NickNaso left a comment

Choose a reason for hiding this comment

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

LGTM

@NickNaso
Copy link
Copy Markdown
Member

NickNaso commented Jan 10, 2019

Hi @bmacnaughton,
if you want add examples on documentation, you can refer on patterns the we follow in this part of the actual documentation:
https://github.com/nodejs/node-addon-api/blob/master/doc/async_worker.md#example
https://github.com/nodejs/node-addon-api/blob/master/doc/error_handling.md#examples-with-c-exceptions-enabled
https://github.com/nodejs/node-addon-api/blob/master/doc/async_context.md#example

In general we added the Example section after the API documentation. Feel free to be expressuve as you want. If your example are too complex maybe we need to consider the idea of creating an example to push on node-addon-example repo.

@bmacnaughton
Copy link
Copy Markdown
Contributor Author

bmacnaughton commented Jan 10, 2019

Thanks. I'll take a look and think about it a bit.

@NickNaso
Copy link
Copy Markdown
Member

NickNaso commented Jan 10, 2019 •
edited
Loading

@bmacnaughton please if it could help you, feel free to open an issue about that so we can sharing all the ideas together.

@DaAitch
Copy link
Copy Markdown
Contributor

DaAitch commented Jan 16, 2019 •
edited
Loading

I hope I don't mix this, but as long as documentation is maintained twice, both should be up to date, but in the future we want to get rid of /doc (with #368), correct? So we should get #368 done soon?

mhdawson pushed a commit that referenced this pull request Mar 4, 2019
@bmacnaughton @mhdawson
doc: minor doc corrections and clarifications
c629553 
- class_property_descriptor - Contructor => Constructor
- object - returns *undefined* not NULL if key doesn't exist
- object_wrap - Contructor => Constructor
- property_descriptor - environemnt => environment

PR-URL: #426
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: NickNaso <nicoladelgobbo@gmail.com>
@mhdawson
Copy link
Copy Markdown
Member

mhdawson commented Mar 4, 2019

Landed as c629553. @bmacnaughton thanks for the updates.

@mhdawson mhdawson closed this Mar 4, 2019
@bmacnaughton bmacnaughton deleted the minor-doc-fixes branch May 17, 2019 16:46
kevindavies8 added a commit to kevindavies8/node-addon-api-Develop that referenced this pull request Aug 24, 2022
@kevindavies8
doc: minor doc corrections and clarifications
53cb3de 
- class_property_descriptor - Contructor => Constructor
- object - returns *undefined* not NULL if key doesn't exist
- object_wrap - Contructor => Constructor
- property_descriptor - environemnt => environment

PR-URL: nodejs/node-addon-api#426
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: NickNaso <nicoladelgobbo@gmail.com>
Marlyfleitas added a commit to Marlyfleitas/node-api-addon-Development that referenced this pull request Aug 26, 2022
@Marlyfleitas
doc: minor doc corrections and clarifications
4a39364 
- class_property_descriptor - Contructor => Constructor
- object - returns *undefined* not NULL if key doesn't exist
- object_wrap - Contructor => Constructor
- property_descriptor - environemnt => environment

PR-URL: nodejs/node-addon-api#426
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: NickNaso <nicoladelgobbo@gmail.com>
wroy7860 added a commit to wroy7860/addon-api-benchmark-node that referenced this pull request Sep 19, 2022
@wroy7860
doc: minor doc corrections and clarifications
091b09c 
- class_property_descriptor - Contructor => Constructor
- object - returns *undefined* not NULL if key doesn't exist
- object_wrap - Contructor => Constructor
- property_descriptor - environemnt => environment

PR-URL: nodejs/node-addon-api#426
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: NickNaso <nicoladelgobbo@gmail.com>
johnfrench3 pushed a commit to johnfrench3/node-addon-api-git that referenced this pull request Aug 11, 2023
doc: minor doc corrections and clarifications
23c549a 
- class_property_descriptor - Contructor => Constructor
- object - returns *undefined* not NULL if key doesn't exist
- object_wrap - Contructor => Constructor
- property_descriptor - environemnt => environment

PR-URL: nodejs/node-addon-api#426
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: NickNaso <nicoladelgobbo@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@NickNaso NickNaso NickNaso approved these changes

@mhdawson mhdawson mhdawson 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.

4 participants

@bmacnaughton @mhdawson @NickNaso @DaAitch