Features/Sugar3 Docs: Difference between revisions
m FGrose moved page Features/Sugar3Docs to Features/Sugar3 Docs: deCamelCase to enable wiki word search |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 11: | Line 11: | ||
* Targeted release: 0.108 | * Targeted release: 0.108 | ||
* Last updated: 8/Aug | * Last updated: 8/Aug | ||
* Percentage of completion: 10% | * Percentage of completion: 10% (see [https://developer.sugarlabs.org/sugar3/ documentation website]) | ||
== Detailed Description == | == Detailed Description == | ||
* Create a sphinx configuration file so we can have a website (DONE) | * Create a sphinx configuration file so we can have a website (DONE) | ||
* Translate existing docs into 1 consistent style | * Translate existing docs into 1 consistent style | ||
* Write docs for all other public ''sugar3'' classes | * Write docs for all other public ''sugar3'' classes, see [[/How To Write]] | ||
=== Example Docstring === | === Example Docstring === | ||
Let's just use google style doc strings, they are very clean and | Let's just use google style doc strings, they are very clean and similar to the current style. [http://sphinx-doc.org/ext/example_google.html#example-google Longer example.] | ||
<nowiki> | <nowiki> | ||
| Line 74: | Line 74: | ||
Args: | Args: | ||
happy (bool): a description for happy | happy (bool): a description for happy | ||
lol (bool | |||
Keyword Arguments: | |||
lol (bool): a optional argument, explain what | |||
it defaults to | it defaults to | ||
| Line 106: | Line 108: | ||
== Release Notes == | == Release Notes == | ||
The Sugar | The Sugar Toolkit has improved API documentation. See https://developer.sugarlabs.org/sugar3/ | ||
== Comments and Discussion == | == Comments and Discussion == | ||