diff --git a/docs/writing/reading.rst b/docs/writing/reading.rst index 910e2752d..39b0888bf 100644 --- a/docs/writing/reading.rst +++ b/docs/writing/reading.rst @@ -8,6 +8,14 @@ one thing that Python programmers do is read code. One of the secrets of becoming a great Python programmer is to read, understand, and comprehend excellent code. +.. raw:: html + + + + Excellent code typically follows the guidelines outlined in :ref:`code_style`, and does its best to express a clear and concise intent to the reader. @@ -45,7 +53,6 @@ reading. Each one of these projects is a paragon of Python coding. - `Tablib `_ Tablib is a format-agnostic tabular dataset library, written in Python. -.. todo:: Embed and explain YouTube video showing python code reading: http://www.youtube.com/watch?v=Jc8M9-LoEuo This may require installing a Sphinx plugin. https://bitbucket.org/birkenfeld/sphinx-contrib/src/a09f29fc16970f34350ca36ac7f229e00b1b1674/youtube?at=default .. todo:: Include code examples of exemplary code from each of the projects listed. Explain why it is excellent code. Use complex examples.