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.

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

Add more examples to the reference documentation #651

Closed
pjcozzi opened this issue Apr 18, 2013 · 4 comments
Closed

Add more examples to the reference documentation #651

pjcozzi opened this issue Apr 18, 2013 · 4 comments
Labels
category - doc good first issue An opportunity for first time contributors

Comments

@pjcozzi
Copy link
Contributor

pjcozzi commented Apr 18, 2013

Some parts of the reference doc have enough examples, others could use more. For example, only some Matrix4.js members have examples (search for @example). Of course, trivial members, like boolean properties, do not need examples.

A reasonable approach here would be to start with the files in Core, and to open pull requests for every file or every few files.

@pratnala
Copy link

Hi, can I get some pointers for this? How to start etc.?

@pjcozzi
Copy link
Contributor Author

pjcozzi commented Apr 30, 2013

@pratnala thanks for the interest.

Take a look at the reference doc (in the code comments) for some of the files in Core that interest you. For example, perhaps Cartesian3.js or Matrix3.js. Add short code examples (using @example) to the reference doc for non-trivial members. For an example, see Cartesian3.fromArray in Cartesian3.js.

For these files, you may be able to base examples on the tests: Cartesian3Spec.js and Matrix3Spec.js.

@nobelium
Copy link
Contributor

nobelium commented May 1, 2013

@pjcozzi I have added examples for Matrix4.js and opened a pull request #724

pjcozzi added a commit that referenced this issue May 2, 2013
Added examples in Matrix4.js for #651
@pjcozzi pjcozzi added the 1.0 label May 8, 2014
@pjcozzi
Copy link
Contributor Author

pjcozzi commented May 22, 2014

This can happen as needed as part of #1684

@pjcozzi pjcozzi closed this as completed May 22, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category - doc good first issue An opportunity for first time contributors
Projects
None yet
Development

No branches or pull requests

3 participants