dupeguru/core/gui/__init__.py

"""
Meta GUI elements in dupeGuru
-----------------------------

dupeGuru is designed with a `cross-toolkit`_ approach in mind. It means that its core code
(which doesn't depend on any GUI toolkit) has elements which preformat core information in a way
that makes it easy for a UI layer to consume.

For example, we have :class:`~core.gui.ResultTable` which takes information from
:class:`~core.results.Results` and mashes it in rows and columns which are ready to be fetched by
either Cocoa's ``NSTableView`` or Qt's ``QTableView``. It tells them which cell is supposed to be
blue, which is supposed to be orange, does the sorting logic, holds selection, etc..

.. _cross-toolkit: http://www.hardcoded.net/articles/cross-toolkit-software
"""
Began serious code documentation effort Enabled the autodoc Sphinx extension and started adding docstrings to classes, methods, etc.. It's quickly becoming quite interesting... 2013-08-18 22:36:09 +00:00			`"""`
			`Meta GUI elements in dupeGuru`
			`-----------------------------`

			dupeGuru is designed with a `cross-toolkit`_ approach in mind. It means that its core code
			`(which doesn't depend on any GUI toolkit) has elements which preformat core information in a way`
			`that makes it easy for a UI layer to consume.`

			For example, we have :class:`~core.gui.ResultTable` which takes information from
			:class:`~core.results.Results` and mashes it in rows and columns which are ready to be fetched by
			either Cocoa's ``NSTableView`` or Qt's ``QTableView``. It tells them which cell is supposed to be
			`blue, which is supposed to be orange, does the sorting logic, holds selection, etc..`

			`.. _cross-toolkit: http://www.hardcoded.net/articles/cross-toolkit-software`
Added tox configuration ... and fixed pep8 warnings. There's a lot of them that are still ignored, but that's because it's too much of a step to take at once. 2014-10-13 19:08:59 +00:00			`"""`