search

microsoft / ChakraCore-wiki

A mirror of the ChakraCore wiki to enable pull requests on the Wiki.
https://github.com/Microsoft/ChakraCore/wiki
Other
22 stars 30 forks source link

Document module API #49

Closed rhuanjl closed 6 years ago

rhuanjl commented 6 years ago

@liminzhu I've gone a bit beyond what the header comments say to try and make these easier to understand - hope it's good.

dilijev commented 6 years ago

@rhuanjl I think the header doc comments and the wiki should be kept in sync if possible. Any updates accepted here should be propagated to the header files. Feel free to open a PR to make that update after this change is reviewed and lands.

liminzhu commented 6 years ago

@dilijev there are a few other places where wiki and header don't match. Ideally we could use a script to two-way sync the wiki and header.

rhuanjl commented 6 years ago

I will post a PR to update the header to match these descriptions if wanted - several of the descriptions seemed rather brief/fragmentary hence trying to fleshing it out whilst formatting it for the wiki.

dilijev commented 6 years ago

Ideally we could use a script to two-way sync the wiki and header.

@liminzhu ideally, yes, or one generates the other (most likely from source to wiki) which would be much easier than a two-way sync.

liminzhu commented 6 years ago

:shipit:

rhuanjl commented 6 years ago

Thanks @liminzhu @dilijev

I'll send a followup PR to update the header to match later today or maybe tomorrow.