documentation improvements

Author: behackl

manim/utils/color/AS2700.py

@@ -1,23 +1,24 @@
-# from https://www.w3schools.com/colors/colors_australia.asp
-"""
-Australian Color Standard
+"""Australian Color Standard
+
+In 1985 the Australian Independent Color Standard AS 2700 was created. In
+this standard, all colors can be identified via a category code (one of
+B -- Blue, G -- Green, N -- Neutrals (grey), P -- Purple, R -- Red, T -- Blue/Green,
+X -- Yellow/Red, Y -- Yellow) and a number. The colors also have (natural) names.
+
+To use the colors from this list, access them directly from the module (which
+is exposed to Manim's global name space):
 
-Before 1985, Australians used the British color standard BS 381C.
+.. code:: pycon
 
-In 1985 the Australian Independent Colour Standard AS 2700 was created:
-Code	Color
-B	Blue
-G	Green
-N	Neutrals (grey)
-P	Purple
-R	Red
-T	Blue/Green
-X	Yellow/Red
-Y	Yellow
+    >>> from manim import AS2700
+    >>> AS2700.B23_BRIGHT_BLUE
+    ManimColor('#174F90')
 
-The codes (or names) cannot be used in HTML.
+List of Color Constants
+-----------------------
 
-These hex values are non official approximate values intended to simulate AS 2700 colors:
+These hex values (taken from `https://www.w3schools.com/colors/colors_australia.asp`__)
+are non official approximate values intended to simulate AS 2700 colors:
 
 .. automanimcolormodule:: manim.utils.color.AS2700
 

manim/utils/color/BS381.py

@@ -1,8 +1,25 @@
-# from https://www.w3schools.com/colors/colors_british.asp
-"""
-The British Standards for colors is called BS 381.
+"""British Color Standard
+
+This module contains colors defined in one of the British Standards
+for colors, BS381C. This standard specifies colors used in identification,
+coding, and other special purposes. See `https://www.britishstandardcolour.com/`__
+for more information.
+
+To use the colors from this list, access them directly from the module (which
+is exposed to Manim's global name space):
+
+.. code:: pycon
+
+    >>> from manim import BS381
+    >>> BS381.OXFORD_BLUE
+    ManimColor('#1F3057')
+
+List of Color Constants
+-----------------------
 
-These hex values are non official approximate values intended to simulate the BS 381:
+These hex values (taken from `https://www.w3schools.com/colors/colors_british.asp`__)
+are non official approximate values intended to simulate the ones defined
+in the standard:
 
 .. automanimcolormodule:: manim.utils.color.BS381
 

manim/utils/color/X11.py

@@ -1,9 +1,24 @@
 # from https://www.w3schools.com/colors/colors_x11.asp
 
-"""
-This list of X11 color names was developed at the
+"""X11 Colors
+
+These color and their names (taken from 
+`https://www.w3schools.com/colors/colors_x11.asp`__) were developed at the
 Massachusetts Intitute of Technology (MIT) during
-the development of color based computer display system:
+the development of color based computer display system.
+
+To use the colors from this list, access them directly from the module (which
+is exposed to Manim's global name space):
+
+.. code:: pycon
+
+    >>> from manim import X11
+    >>> X11.BEIGE
+    ManimColor('#F5F5DC')
+
+
+List of Color Constants
+-----------------------
 
 .. automanimcolormodule:: manim.utils.color.X11
 """

manim/utils/color/XKCD.py

@@ -1,10 +1,24 @@
-# from https://www.w3schools.com/colors/colors_xkcd.asp
-"""
-XKCD Color Names
+"""Colors from the XKCD Color Name Survey
+
+XKCD is a popular `web comic <https://xkcd.com/353/>`__ created by Randall Munroe.
+His "`Color Name Survey <http://blog.xkcd.com/2010/05/03/color-survey-results/>`__" (with
+200000 participants) resulted in a list of nearly 1000 color names.
+
+While the ``XKCD`` module is exposed to Manim's global name space, the colors included
+in it are not. This means that in order to use the colors, access them via the module name:
+
+.. code:: pycon
+
+    >>> from manim import XKCD
+    >>> XKCD.MANGO
+    ManimColor('#FFA62B')
+
+
+List of Color Constants
+-----------------------
 
-XKCD is a popular web comic created by Randall Munroe.
-His "Color Name Survey" (with 200 000 participants) resulted in a list of nearly 1000 color names.
-These hex values are non official approximate values intended to simulate the colors in HTML:
+These hex values are non official approximate values intended to simulate the colors in HTML,
+taken from `https://www.w3schools.com/colors/colors_xkcd.asp`__.
 
 .. automanimcolormodule:: manim.utils.color.XKCD
 

manim/utils/color/__init__.py

@@ -17,15 +17,23 @@
 - The colors listed in :mod:`.color.manim_colors` are loaded into
   Manim's global name space.
 - The colors in :mod:`.color.AS2700`, :mod:`.color.BS381`, :mod:`.color.X11`,
-  and :mod:`.color.XKCD` need to be imported separately, or referred to via
-  their module names. For example:
+  and :mod:`.color.XKCD` need to be accessed via their module (which are available
+  in Manim's global name space), or imported separately. For example:
 
   .. code:: pycon
 
      >>> from manim import XKCD
      >>> XKCD.AVOCADO
      ManimColor('#90B134')
 
+  Or, alternatively:
+
+  .. code:: pycon
+
+     >>> from manim.utils.color.XKCD import AVOCADO
+     >>> AVOCADO
+     ManimColor('#90B134')
+
 The following modules contain the predefined color constants:
 
 .. autosummary::

manim/utils/color/core.py

@@ -1,8 +1,8 @@
-"""Manim's (internal) color class and some utilities for color conversion.
+"""Manim's (internal) color data structure and some utilities for
+color conversion.
 
 This module contains the implementation of :class:`.ManimColor`,
-the class internally used to represent colors.
-
+the data structure internally used to represent colors.
 """