Features/Sugar3 Docs - Revision history

Quozl: /* Example Docstring */

2017-01-03T06:01:59Z

Example Docstring

← Older revision		Revision as of 02:01, 3 January 2017
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

Quozl: /* Example Docstring */

2017-01-03T06:01:11Z

Example Docstring

← Older revision		Revision as of 02:01, 3 January 2017
Line 20:		Line 20:
	=== Example Docstring ===		=== Example Docstring ===

	Let's just use google style doc strings, they are very clean and ~~simmilar~~ to the current style. [http://sphinx-doc.org/ext/example_google.html#example-google Longer example.]		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>

Quozl at 06:00, 3 January 2017

2017-01-03T06:00:04Z

← Older revision		Revision as of 02:00, 3 January 2017
Line 108:		Line 108:

	== Release Notes ==		== Release Notes ==
	The Sugar ~~toolkit now~~ has ~~imporved~~ API documentation ~~coverage~~. ~~View our docs here~~: ~~dev~~.~~sam~~.~~today (real url when it is done of course)~~		The Sugar Toolkit has improved API documentation. See https://developer.sugarlabs.org/sugar3/

	== Comments and Discussion ==		== Comments and Discussion ==

SAMdroid: /* Example Docstring */ Example doc string should have correct format

2017-01-03T04:07:58Z

Example Docstring: Example doc string should have correct format

← Older revision		Revision as of 00:07, 3 January 2017
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 (~~:class:`~~sugar3.graphics.alert.Alert`): remember to link		d (sugar3.graphics.alert.Alert): remember to link
	classes using the correct syntax		classes using the correct syntax

Line 74:		Line 74:
	Args:		Args:
	happy (bool): a description for happy		happy (bool): a description for happy
	lol (bool~~, optional~~): a optional argument, explain what
			Keyword Arguments:
			lol (bool): a optional argument, explain what
	it defaults to		it defaults to

Quozl at 02:06, 3 January 2017

2017-01-03T02:06:42Z

← Older revision		Revision as of 22:06, 2 January 2017
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 ==

Quozl at 22:43, 29 December 2015

2015-12-29T22:43:56Z

← Older revision		Revision as of 18:43, 29 December 2015
Line 16:		Line 16:
	* 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 ===

FGrose: FGrose moved page Features/Sugar3Docs to Features/Sugar3 Docs: deCamelCase to enable wiki word search

2015-12-29T18:30:08Z

FGrose moved page Features/Sugar3Docs to Features/Sugar3 Docs: deCamelCase to enable wiki word search

← Older revision		Revision as of 14:30, 29 December 2015
(No difference)

SAMdroid: /* Example Docstring */

2015-08-07T23:33:54Z

Example Docstring

← Older revision		Revision as of 19:33, 7 August 2015
Line 19:		Line 19:

	=== Example Docstring ===		=== Example Docstring ===

			Let's just use google style doc strings, they are very clean and simmilar to the current style. [http://sphinx-doc.org/ext/example_google.html#example-google Longer example.]

	<nowiki>		<nowiki>

SAMdroid at 23:31, 7 August 2015

2015-08-07T23:31:34Z

@@ Line 17: / Line 17: @@
 * Translate existing docs into 1 consistent style
 * Write docs for all other public ''sugar3'' classes
 == Benefit to Sugar ==

SAMdroid: Created page with ". == Summary == Add developer API documentation to sugar-toolkit-gtk3 in a consistent format. Then, create a site to make the docs available in your bro..."

2015-08-07T23:15:54Z

Created page with ". == Summary == Add developer API documentation to sugar-toolkit-gtk3 in a consistent format. Then, create a site to make the docs available in your bro..."

New page

[[Category:Feature|.]]

== Summary ==
Add developer API documentation to sugar-toolkit-gtk3 in a consistent format. Then, create a site to make the docs available in your browser.

== Owner ==
* Name: [[User:SAMdroid|Sam P.]]
* Email: @sam.today

== Current status ==
* Targeted release: 0.108
* Last updated: 8/Aug
* Percentage of completion: 10%

== Detailed Description ==
* Create a sphinx configuration file so we can have a website (DONE)
* Translate existing docs into 1 consistent style
* Write docs for all other public ''sugar3'' classes

== Benefit to Sugar ==
This will allow developers to create activities more eaisly. They will no longer have to look thought the source code th understand how the api works, they will instead (hopefully) have understandable docs with good working code samples.

== Scope ==
This will require lots of changes in the docstrings. However, no changes will be made to code that runs on users machines.

==UI Design==
Example docs: http://dev.sam.today/ http://dev.sam.today/sugar3.graphics.alert/ http://dev.sam.today/sugar3.graphics.animator/

== How To Test ==
* View docs
* Try code samples

== User Experience ==
None for sugar users.

== Dependencies ==
None

== Contingency Plan ==
None

== Release Notes ==
The Sugar toolkit now has imporved API documentation coverage. View our docs here: dev.sam.today (real url when it is done of course)

== Comments and Discussion ==

* https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/248
* ''Link to the discussion of this feature on lists.sugarlabs.org''
* See [[{{TALKPAGENAME}}|the discussion tab for this feature.]]