search

chakra-core / ChakraCore

ChakraCore is an open source Javascript engine with a C API.
MIT License
9.11k stars 1.2k forks source link

jsrt: Help US to update documentation and samples #4286

Open obastemur opened 6 years ago

obastemur commented 6 years ago

Recent changes, we have differences between ChakraCore JSRT docs and the actual implementation. (including the new API I have recently added)

[optional, bonus] ++ add more samples to https://github.com/Microsoft/Chakra-Samples/tree/master/ChakraCore%20Samples (move sample.cpp from this repo's test/native-tests/pick-a-sub-folder and add code comments)

EDIT: more detail and typos

dianahinz commented 6 years ago

https://github.com/Microsoft/ChakraCore/blob/master/test/native-tests/test-static-property/sample.cpp ?

Announcement commented 6 years ago

If I have time wednesday I'm pretty good at writing documentation and samples if no one beats me to it by then.

liminzhu commented 6 years ago

To give some extra pointers, we miss docs for modules APIs in ChakraCore.h and debugging APIs in ChakraDebug.h. Would appreciate PRs to https://github.com/Microsoft/ChakraCore-wiki for docs.

Samples go to https://github.com/Microsoft/Chakra-samples.

obastemur commented 6 years ago

@mattzeunert did a nice job by documenting xcode output -> https://github.com/Microsoft/ChakraCore-wiki/pull/45