Address a few sphinx warnings (#846)

* CLN : Address a few sphinx warnings Not sure if this is the right fix but this is a fix modified: pyface/tasks/tasks_application.py modified: pyface/timer/do_later.py * Update pyface/timer/do_later.py Co-authored-by: Kit Choi <[email protected]> Co-authored-by: Kit Choi <[email protected]>
enthought · Dec 16, 2020 · 4a991af · 4a991af
1 parent 98e191c
commit 4a991af
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/pyface/tasks/tasks_application.py b/pyface/tasks/tasks_application.py
@@ -44,7 +44,7 @@ class TaskFactory(HasStrictTraits):
 
     #: A callable with the following signature:
     #:
-    #:     callable(**traits) -> Task
+    #:     callable(\**traits) -> Task
     #:
     #: Often this attribute will simply be a Task subclass.
     factory = Callable

diff --git a/pyface/timer/do_later.py b/pyface/timer/do_later.py
@@ -38,7 +38,7 @@ def do_later(callable, *args, **kwargs):
     ----------
     callable : callable
         The callable to call in 50ms time.
-    *args, **kwargs : tuple, dict
+    *args, \**kwargs : tuple, dict
         Arguments to be passed through to the callable.
     """
     return CallbackTimer.single_shot(
@@ -55,7 +55,10 @@ def do_after(interval, callable, *args, **kwargs):
         The time interval in milliseconds to wait before calling.
     callable : callable
         The callable to call.
-    *args, **kwargs : tuple, dict
+    \*args
+        Positional arguments to be passed through to the callable.
+    \*\*kwargs
+        Keyword arguments to be passed through to the callable.
         Arguments to be passed through to the callable.
     """
     return CallbackTimer.single_shot(