a-maze-d / fledex / 9477d6c5a4b0bc280f325198cf4baab90c62e730

100%

push

github

Cleanup and improved  api docs (#64)

* minor documentation updates

* BIG cleanup and doc improvement

* Adding a module for HSV (requires increasing xref to 19)
* Adding documentation for the conversion functions
* Cleaning up and restructuring the conversion modules
* Adding expert to the .gitignore exclusion list
* Replaced the cone_response picture with a version under a different license. Thereby  removing the CC-BY-SA-3.0 license with a CC-BY-SA-4.0 license (which is open source compliant)
* Updated the CREDITS.md file
* Minor improvements to the livebooks for the school (German)
* Added information about color correction to the 3b livebook
* Fixed a documentation bug. The hue value in HSV is a byte representing 360 degrees.
* Improved the README.md
* Updated the TODO.md

* forgotten from last commit

* * improving the API documentation
* standardizing notes, cautions, ...  in documentation
* introducing a color name interface
* integrating the color.guards into the color.names module
* any atom can be a valid color (from a protocol perspective), thereby even resolving RAL names
* Restructured the API documentation to make the more useful infromation easier accessible
* adjusted the code complexity check, because the color changes reduced the code complexity
* Updating TODO.md (including an idea on how to further reduce the complexity)

---------

Co-authored-by: maze <fledex@reik.org>

49 of 49 new or added lines in 8 files covered. (100.0%)

885 of 885 relevant lines covered (100.0%)

469.74 hits per line