Features/Sugar3 Docs: Difference between revisions
→Example Docstring: Example doc string should have correct format |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 20: | Line 20: | ||
=== 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 56: | Line 56: | ||
that you can invoke using the **kwargs | that you can invoke using the **kwargs | ||
c (int): desctiption of c | c (int): desctiption of c | ||
d (sugar3.graphics.alert.Alert): remember to link | d (:class:`sugar3.graphics.alert.Alert`): remember to link | ||
classes using the correct syntax | classes using the correct syntax | ||
| Line 108: | 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 == | ||