From 44d88fc834ee3e425d4347dcae930220f20401fb Mon Sep 17 00:00:00 2001 From: Zen-CODE Date: Fri, 29 Mar 2013 03:38:47 -0500 Subject: [PATCH] Revisions to /guide/readingdoc.rst --- doc/sources/guide/readingdoc.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/sources/guide/readingdoc.rst b/doc/sources/guide/readingdoc.rst index 1d6e8a62f..d18842b47 100644 --- a/doc/sources/guide/readingdoc.rst +++ b/doc/sources/guide/readingdoc.rst @@ -1,23 +1,23 @@ How to read the documentation ============================= -The documentation is seperated in 2 parts: +The documentation is seperated into 2 parts: - the Programming Guide: it's a must read to understand the Kivy - basics, specially if you never done GUI programming before. + basics, especially if you have never done GUI programming before. - the API: all the functions, classes, methods are explained. Importing a class ----------------- -The API part is autogenerated from the source code. If you take any class, -it will be generated like this: +The API section is autogenerated from the source code. Taking any class, +the documentation will look something like this: .. image:: images/api-button.jpg -It should be read like this: the "Button" class is in the "kivy.uix.button" -module. So if you want to import that class in your code, write that:: +It should be read as follows: the "Button" class is in the "kivy.uix.button" +module. If you want to import the class in your code, you will write:: from kivy.uix.button import Button