arsenetar/dupeguru
1
0
Fork 0
mirror of https://github.com/arsenetar/dupeguru.git synced 2025-03-10 05:34:36 +00:00
Code Releases Wiki Activity

Included hscommon.jobprogress in the devdocs

Browse Source
This commit is contained in:
Virgil Dupras 2014-10-05 17:12:10 -04:00
parent ac32305532
commit 44266273bf
6 changed files with 48 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
help/conf.tmpl
View File

@ -25,7 +25,7 @@ sys.path.insert(0, os.path.abspath(os.path.join('..', '..')))
def fix_nulljob_in_sig(app, what, name, obj, options, signature, return_annotation): def fix_nulljob_in_sig(app, what, name, obj, options, signature, return_annotation):
if signature: if signature:
signature = re.sub(r"<jobprogress.job.NullJob object at 0x[\da-f]+>", "nulljob", signature) signature = re.sub(r"<hscommon.jobprogress.job.NullJob object at 0x[\da-f]+>", "nulljob", signature)
return signature, return_annotation return signature, return_annotation
def setup(app): def setup(app):

11
help/en/developer/hscommon/index.rst
View File

@ -3,6 +3,7 @@ hscommon
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:glob:
build build
conflict conflict
@ -10,10 +11,6 @@ hscommon
notify notify
path path
util util
gui/base jobprogress/*
gui/text_field gui/*
gui/selectable_list
gui/table
gui/tree
gui/column
gui/progress_window

17
help/en/developer/hscommon/jobprogress/job.rst Normal file
View File

@ -0,0 +1,17 @@
hscommon.jobprogress.job
========================
.. automodule:: hscommon.jobprogress.job
.. autosummary::
Job
NullJob
.. autoclass:: Job
:members:
:private-members:
.. autoclass:: NullJob
:members:

12
help/en/developer/hscommon/jobprogress/performer.rst Normal file
View File

@ -0,0 +1,12 @@
hscommon.jobprogress.performer
==============================
.. automodule:: hscommon.jobprogress.performer
.. autosummary::
ThreadedJobPerformer
.. autoclass:: ThreadedJobPerformer
:members:

12
help/en/developer/hscommon/jobprogress/qt.rst Normal file
View File

@ -0,0 +1,12 @@
hscommon.jobprogress.qt
=======================
.. automodule:: hscommon.jobprogress.qt
.. autosummary::
Progress
.. autoclass:: Progress
:members:

4
hscommon/gui/progress_window.py
View File

@ -48,7 +48,7 @@ class ProgressWindow(GUIObject, ThreadedJobPerformer):
:meth:`pulse` in the main thread because GUI toolkit usually only support calling UI-related :meth:`pulse` in the main thread because GUI toolkit usually only support calling UI-related
functions from the main thread. functions from the main thread.
We subclass :class:`.GUIObject` and :class:`ThreadedJobPerformer`. We subclass :class:`.GUIObject` and :class:`.ThreadedJobPerformer`.
Expected view: :class:`ProgressWindowView`. Expected view: :class:`ProgressWindowView`.
:param finishfunc: A function ``f(jobid)`` that is called when a job is completed. ``jobid`` is :param finishfunc: A function ``f(jobid)`` that is called when a job is completed. ``jobid`` is
@ -102,7 +102,7 @@ class ProgressWindow(GUIObject, ThreadedJobPerformer):
def run(self, jobid, title, target, args=()): def run(self, jobid, title, target, args=()):
"""Starts a threaded job. """Starts a threaded job.
The ``target`` function will be sent, as its first argument, a :class:`Job` instance which The ``target`` function will be sent, as its first argument, a :class:`.Job` instance which
it can use to report on its progress. it can use to report on its progress.
:param jobid: Arbitrary identifier which will be passed to ``finish_func()`` at the end. :param jobid: Arbitrary identifier which will be passed to ``finish_func()`` at the end.