How are the examples and code snippets mastered and processed?

[vsubramani]

I am looking into understanding how gcloud-node handles documentation and code examples, to learn more about where the doc example snippets are mastered and how they are automatically validated etc.

JJ mentioned that the best way to reach the team was to open a github issue. Would one of the owners be able to reach me so that we can a quick 30 min sync?

(JJ: removing confidential content)

[jgeewax]

How about we just answer here.... Do you have specific questions that you want answered?

(I also removed confidential stuff -- sorry for editing your comment out from under you)

[jgeewax]

Also -- what do you mean by "mastered"?

[callmehiphop]

Our example code is tested when we run npm run test, this does the following:

• Transforms JSDoc into JSON using dox (via shell script)
• Runs all unit tests via Mocha.

There is a documentation spec file that then parses all the JSON generated via dox and proceeds to run all of the @example sections within a sandboxed environment created using Node's vm module and mitm.

[jgeewax]

@vsubramani : Does this answer your question ?

[stephenplusplus]

Feel free to continue discussing if you have more questions @vsubramani. Thanks for asking!

[vsubramani]

This answers my question. Thanks folks.