Category:Needs Code Sample: Difference between revisions
Jump to navigation
Jump to search
Created page with 'Please do your part in helping to document ash functions! Pages in this category have been flagged as needing code samples; it would really help us out if you provided one. ==W…' |
Added links to Template:FunctionPage and Template:CodeSample. |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__HIDDENCAT__ | |||
Please do your part in helping to document ash functions! | Please do your part in helping to document ash functions! | ||
Pages in this category have been flagged as needing code samples; it would really help us out if you provided one. | Pages in this category have been flagged as needing code samples; it would really help us out if you provided one. See [[Template:FunctionPage]] and [[Template:CodeSample]] for details on how to add code samples. | ||
==What makes a good code sample?== | ==What makes a good code sample?== | ||
| Line 13: | Line 14: | ||
** Place the line inside the function template call, after <nowiki>"{{FunctionPage|"</nowiki> | ** Place the line inside the function template call, after <nowiki>"{{FunctionPage|"</nowiki> | ||
** Don't put it inside another template call; if in doubt, the line right after <nowiki>"{{FunctionPage|"</nowiki> is ok. | ** Don't put it inside another template call; if in doubt, the line right after <nowiki>"{{FunctionPage|"</nowiki> is ok. | ||
* If you see a page that does have code samples, but they're | * If you see a page that does have code samples, but they're unclear, too complicated, etc., you can add <nowiki>"improvecode=yes|"</nowiki> | ||
** Place this line the same way as for <nowiki>"needscode=yes|"</nowiki> | ** Place this line the same way as for <nowiki>"needscode=yes|"</nowiki> | ||
Latest revision as of 18:00, 28 June 2010
Please do your part in helping to document ash functions!
Pages in this category have been flagged as needing code samples; it would really help us out if you provided one. See Template:FunctionPage and Template:CodeSample for details on how to add code samples.
What makes a good code sample?
- Clearly shows how to use the function in a typical manner (not in some jury-rigged I-guess-you-could-do-it-that-way... er... way).
- Isn't overly complicated; if the function doesn't return aggregates or use them as parameters, try to avoid them in the sample, for example.
- Ideally, the code sample would be useful in some way, shape or form; even if it just duplicates other functionality (if it does, mention it in the code as a comment).
I'm bad at coding, or don't feel up to it right now; is there another way I can help?
- Yes! If you see a function page that needs a code sample & doesn't have one, edit the page to include the line "needscode=yes|".
- Place the line inside the function template call, after "{{FunctionPage|"
- Don't put it inside another template call; if in doubt, the line right after "{{FunctionPage|" is ok.
- If you see a page that does have code samples, but they're unclear, too complicated, etc., you can add "improvecode=yes|"
- Place this line the same way as for "needscode=yes|"
Pages in category "Needs Code Sample"
The following 76 pages are in this category, out of 76 total.