From 9950e71b29c1a846db91cc68322a3f22932f7a26 2011-06-20 23:40:20 From: MinRK Date: 2011-06-20 23:40:20 Subject: [PATCH] update recently changed modules with Authors in docstring --- diff --git a/IPython/config/application.py b/IPython/config/application.py index ae3dfa6..04dbe86 100644 --- a/IPython/config/application.py +++ b/IPython/config/application.py @@ -5,6 +5,7 @@ A base class for a configurable application. Authors: * Brian Granger +* Min RK """ #----------------------------------------------------------------------------- diff --git a/IPython/config/configurable.py b/IPython/config/configurable.py index 5d3abe7..433195f 100755 --- a/IPython/config/configurable.py +++ b/IPython/config/configurable.py @@ -7,10 +7,11 @@ Authors: * Brian Granger * Fernando Perez +* Min RK """ #----------------------------------------------------------------------------- -# Copyright (C) 2008-2010 The IPython Development Team +# Copyright (C) 2008-2011 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. diff --git a/IPython/config/loader.py b/IPython/config/loader.py index ca9025a..7ef6534 100644 --- a/IPython/config/loader.py +++ b/IPython/config/loader.py @@ -4,10 +4,11 @@ Authors ------- * Brian Granger * Fernando Perez +* Min RK """ #----------------------------------------------------------------------------- -# Copyright (C) 2008-2009 The IPython Development Team +# Copyright (C) 2008-2011 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. diff --git a/IPython/core/newapplication.py b/IPython/core/newapplication.py index de61f70..4b736a4 100644 --- a/IPython/core/newapplication.py +++ b/IPython/core/newapplication.py @@ -12,6 +12,7 @@ Authors: * Brian Granger * Fernando Perez +* Min RK Notes ----- diff --git a/IPython/parallel/__init__.py b/IPython/parallel/__init__.py index a794fb4..be293bc 100644 --- a/IPython/parallel/__init__.py +++ b/IPython/parallel/__init__.py @@ -1,4 +1,9 @@ -"""The IPython ZMQ-based parallel computing interface.""" +"""The IPython ZMQ-based parallel computing interface. + +Authors: + +* MinRK +""" #----------------------------------------------------------------------------- # Copyright (C) 2011 The IPython Development Team # diff --git a/IPython/parallel/apps/baseapp.py b/IPython/parallel/apps/baseapp.py index 49834c1..081cd6c 100755 --- a/IPython/parallel/apps/baseapp.py +++ b/IPython/parallel/apps/baseapp.py @@ -1,11 +1,17 @@ #!/usr/bin/env python # encoding: utf-8 """ -The IPython cluster directory +The Base Application class for IPython.parallel apps + +Authors: + +* Brian Granger +* Min RK + """ #----------------------------------------------------------------------------- -# Copyright (C) 2008-2009 The IPython Development Team +# Copyright (C) 2008-2011 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. diff --git a/IPython/parallel/apps/ipclusterapp.py b/IPython/parallel/apps/ipclusterapp.py index ce8c534..4b59516 100755 --- a/IPython/parallel/apps/ipclusterapp.py +++ b/IPython/parallel/apps/ipclusterapp.py @@ -2,10 +2,16 @@ # encoding: utf-8 """ The ipcluster application. + +Authors: + +* Brian Granger +* MinRK + """ #----------------------------------------------------------------------------- -# Copyright (C) 2008-2009 The IPython Development Team +# Copyright (C) 2008-2011 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. diff --git a/IPython/parallel/apps/ipcontrollerapp.py b/IPython/parallel/apps/ipcontrollerapp.py index c0f66c2..bda9cc5 100755 --- a/IPython/parallel/apps/ipcontrollerapp.py +++ b/IPython/parallel/apps/ipcontrollerapp.py @@ -2,10 +2,16 @@ # encoding: utf-8 """ The IPython controller application. + +Authors: + +* Brian Granger +* MinRK + """ #----------------------------------------------------------------------------- -# Copyright (C) 2008-2009 The IPython Development Team +# Copyright (C) 2008-2011 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. diff --git a/IPython/parallel/apps/ipengineapp.py b/IPython/parallel/apps/ipengineapp.py index 3130eb4..b6676bc 100755 --- a/IPython/parallel/apps/ipengineapp.py +++ b/IPython/parallel/apps/ipengineapp.py @@ -2,10 +2,16 @@ # encoding: utf-8 """ The IPython engine application + +Authors: + +* Brian Granger +* MinRK + """ #----------------------------------------------------------------------------- -# Copyright (C) 2008-2009 The IPython Development Team +# Copyright (C) 2008-2011 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. diff --git a/IPython/parallel/apps/iploggerapp.py b/IPython/parallel/apps/iploggerapp.py index 1f14979..2d48254 100755 --- a/IPython/parallel/apps/iploggerapp.py +++ b/IPython/parallel/apps/iploggerapp.py @@ -2,6 +2,11 @@ # encoding: utf-8 """ A simple IPython logger application + +Authors: + +* MinRK + """ #----------------------------------------------------------------------------- diff --git a/IPython/parallel/apps/launcher.py b/IPython/parallel/apps/launcher.py index 521b6e9..3f63b1a 100644 --- a/IPython/parallel/apps/launcher.py +++ b/IPython/parallel/apps/launcher.py @@ -2,10 +2,15 @@ # encoding: utf-8 """ Facilities for launching IPython processes asynchronously. + +Authors: + +* Brian Granger +* MinRK """ #----------------------------------------------------------------------------- -# Copyright (C) 2008-2009 The IPython Development Team +# Copyright (C) 2008-2011 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. diff --git a/IPython/parallel/apps/logwatcher.py b/IPython/parallel/apps/logwatcher.py index 17de05b..49599db 100644 --- a/IPython/parallel/apps/logwatcher.py +++ b/IPython/parallel/apps/logwatcher.py @@ -1,5 +1,12 @@ #!/usr/bin/env python -"""A simple logger object that consolidates messages incoming from ipcluster processes.""" +""" +A simple logger object that consolidates messages incoming from ipcluster processes. + +Authors: + +* MinRK + +""" #----------------------------------------------------------------------------- # Copyright (C) 2011 The IPython Development Team diff --git a/IPython/parallel/apps/win32support.py b/IPython/parallel/apps/win32support.py index 9d97225..48cb168 100644 --- a/IPython/parallel/apps/win32support.py +++ b/IPython/parallel/apps/win32support.py @@ -1,7 +1,13 @@ #!/usr/bin/env python """Utility for forwarding file read events over a zmq socket. -This is necessary because select on Windows only supports""" +This is necessary because select on Windows only supports + +Authors: + +* MinRK + +""" #----------------------------------------------------------------------------- # Copyright (C) 2011 The IPython Development Team diff --git a/IPython/parallel/apps/winhpcjob.py b/IPython/parallel/apps/winhpcjob.py index 7a39cb0..7a29d0a 100644 --- a/IPython/parallel/apps/winhpcjob.py +++ b/IPython/parallel/apps/winhpcjob.py @@ -3,10 +3,16 @@ """ Job and task components for writing .xml files that the Windows HPC Server 2008 can use to start jobs. + +Authors: + +* Brian Granger +* MinRK + """ #----------------------------------------------------------------------------- -# Copyright (C) 2008-2009 The IPython Development Team +# Copyright (C) 2008-2011 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. diff --git a/IPython/parallel/client/asyncresult.py b/IPython/parallel/client/asyncresult.py index ab87c55..291046f 100644 --- a/IPython/parallel/client/asyncresult.py +++ b/IPython/parallel/client/asyncresult.py @@ -1,4 +1,9 @@ -"""AsyncResult objects for the client""" +"""AsyncResult objects for the client + +Authors: + +* MinRK +""" #----------------------------------------------------------------------------- # Copyright (C) 2010-2011 The IPython Development Team # diff --git a/IPython/parallel/client/client.py b/IPython/parallel/client/client.py index 72c8b90..b330574 100644 --- a/IPython/parallel/client/client.py +++ b/IPython/parallel/client/client.py @@ -1,6 +1,11 @@ -"""A semi-synchronous Client for the ZMQ cluster""" +"""A semi-synchronous Client for the ZMQ cluster + +Authors: + +* MinRK +""" #----------------------------------------------------------------------------- -# Copyright (C) 2010 The IPython Development Team +# Copyright (C) 2010-2011 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. diff --git a/IPython/parallel/client/map.py b/IPython/parallel/client/map.py index c2c7b2f..5ea8d96 100644 --- a/IPython/parallel/client/map.py +++ b/IPython/parallel/client/map.py @@ -4,12 +4,19 @@ Scattering consists of partitioning a sequence and sending the various pieces to individual nodes in a cluster. + + +Authors: + +* Brian Granger +* MinRK + """ __docformat__ = "restructuredtext en" #------------------------------------------------------------------------------- -# Copyright (C) 2008 The IPython Development Team +# Copyright (C) 2008-2011 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. diff --git a/IPython/parallel/client/remotefunction.py b/IPython/parallel/client/remotefunction.py index 8cb6a56..cdaccdf 100644 --- a/IPython/parallel/client/remotefunction.py +++ b/IPython/parallel/client/remotefunction.py @@ -1,6 +1,12 @@ -"""Remote Functions and decorators for Views.""" +"""Remote Functions and decorators for Views. + +Authors: + +* Brian Granger +* Min RK +""" #----------------------------------------------------------------------------- -# Copyright (C) 2010 The IPython Development Team +# Copyright (C) 2010-2011 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. diff --git a/IPython/parallel/client/view.py b/IPython/parallel/client/view.py index 812674b..be35241 100644 --- a/IPython/parallel/client/view.py +++ b/IPython/parallel/client/view.py @@ -1,6 +1,11 @@ -"""Views of remote engines.""" +"""Views of remote engines. + +Authors: + +* Min RK +""" #----------------------------------------------------------------------------- -# Copyright (C) 2010 The IPython Development Team +# Copyright (C) 2010-2011 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. diff --git a/IPython/parallel/controller/dependency.py b/IPython/parallel/controller/dependency.py index 5727b24..c046556 100644 --- a/IPython/parallel/controller/dependency.py +++ b/IPython/parallel/controller/dependency.py @@ -1,4 +1,9 @@ -"""Dependency utilities""" +"""Dependency utilities + +Authors: + +* Min RK +""" #----------------------------------------------------------------------------- # Copyright (C) 2010-2011 The IPython Development Team # diff --git a/IPython/parallel/controller/dictdb.py b/IPython/parallel/controller/dictdb.py index 2d23a30..d8caa6a 100644 --- a/IPython/parallel/controller/dictdb.py +++ b/IPython/parallel/controller/dictdb.py @@ -1,6 +1,11 @@ """A Task logger that presents our DB interface, but exists entirely in memory and implemented with dicts. +Authors: + +* Min RK + + TaskRecords are dicts of the form: { 'msg_id' : str(uuid), @@ -35,7 +40,7 @@ We support a subset of mongodb operators: $lt,$gt,$lte,$gte,$ne,$in,$nin,$all,$mod,$exists """ #----------------------------------------------------------------------------- -# Copyright (C) 2010 The IPython Development Team +# Copyright (C) 2010-2011 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. diff --git a/IPython/parallel/controller/heartmonitor.py b/IPython/parallel/controller/heartmonitor.py index c83c688..5e231a3 100644 --- a/IPython/parallel/controller/heartmonitor.py +++ b/IPython/parallel/controller/heartmonitor.py @@ -2,6 +2,10 @@ """ A multi-heart Heartbeat system using PUB and XREP sockets. pings are sent out on the PUB, and hearts are tracked based on their XREQ identities. + +Authors: + +* Min RK """ #----------------------------------------------------------------------------- # Copyright (C) 2010-2011 The IPython Development Team diff --git a/IPython/parallel/controller/hub.py b/IPython/parallel/controller/hub.py index 78c0663..7c1e6de 100755 --- a/IPython/parallel/controller/hub.py +++ b/IPython/parallel/controller/hub.py @@ -2,6 +2,10 @@ """The IPython Controller Hub with 0MQ This is the master object that handles connections from engines and clients, and monitors traffic through the various queues. + +Authors: + +* Min RK """ #----------------------------------------------------------------------------- # Copyright (C) 2010 The IPython Development Team diff --git a/IPython/parallel/controller/mongodb.py b/IPython/parallel/controller/mongodb.py index cb8d4fb..61d2196 100644 --- a/IPython/parallel/controller/mongodb.py +++ b/IPython/parallel/controller/mongodb.py @@ -1,6 +1,11 @@ -"""A TaskRecord backend using mongodb""" +"""A TaskRecord backend using mongodb + +Authors: + +* Min RK +""" #----------------------------------------------------------------------------- -# Copyright (C) 2010 The IPython Development Team +# Copyright (C) 2010-2011 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. diff --git a/IPython/parallel/controller/scheduler.py b/IPython/parallel/controller/scheduler.py index afcfbe7..d015460 100644 --- a/IPython/parallel/controller/scheduler.py +++ b/IPython/parallel/controller/scheduler.py @@ -3,6 +3,10 @@ The Pure ZMQ scheduler does not allow routing schemes other than LRU, nor does it check msg_id DAG dependencies. For those, a slightly slower Python Scheduler exists. + +Authors: + +* Min RK """ #----------------------------------------------------------------------------- # Copyright (C) 2010-2011 The IPython Development Team diff --git a/IPython/parallel/controller/sqlitedb.py b/IPython/parallel/controller/sqlitedb.py index 0d49943..41123ef 100644 --- a/IPython/parallel/controller/sqlitedb.py +++ b/IPython/parallel/controller/sqlitedb.py @@ -1,4 +1,9 @@ -"""A TaskRecord backend using sqlite3""" +"""A TaskRecord backend using sqlite3 + +Authors: + +* Min RK +""" #----------------------------------------------------------------------------- # Copyright (C) 2011 The IPython Development Team # diff --git a/IPython/parallel/engine/engine.py b/IPython/parallel/engine/engine.py index d25697c..bea20b0 100755 --- a/IPython/parallel/engine/engine.py +++ b/IPython/parallel/engine/engine.py @@ -2,6 +2,10 @@ """A simple engine that talks to a controller over 0MQ. it handles registration, etc. and launches a kernel connected to the Controller's Schedulers. + +Authors: + +* Min RK """ #----------------------------------------------------------------------------- # Copyright (C) 2010-2011 The IPython Development Team diff --git a/IPython/parallel/engine/kernelstarter.py b/IPython/parallel/engine/kernelstarter.py index c9b558a..fe92d1d 100644 --- a/IPython/parallel/engine/kernelstarter.py +++ b/IPython/parallel/engine/kernelstarter.py @@ -1,4 +1,9 @@ -"""KernelStarter class that intercepts Control Queue messages, and handles process management.""" +"""KernelStarter class that intercepts Control Queue messages, and handles process management. + +Authors: + +* Min RK +""" #----------------------------------------------------------------------------- # Copyright (C) 2010-2011 The IPython Development Team # diff --git a/IPython/parallel/engine/streamkernel.py b/IPython/parallel/engine/streamkernel.py index b028688..434ea58 100755 --- a/IPython/parallel/engine/streamkernel.py +++ b/IPython/parallel/engine/streamkernel.py @@ -1,6 +1,13 @@ #!/usr/bin/env python """ Kernel adapted from kernel.py to use ZMQ Streams + +Authors: + +* Min RK +* Brian Granger +* Fernando Perez +* Evan Patterson """ #----------------------------------------------------------------------------- # Copyright (C) 2010-2011 The IPython Development Team diff --git a/IPython/parallel/error.py b/IPython/parallel/error.py index 5acf8d5..d27dfb5 100644 --- a/IPython/parallel/error.py +++ b/IPython/parallel/error.py @@ -1,6 +1,12 @@ # encoding: utf-8 -"""Classes and functions for kernel related errors and exceptions.""" +"""Classes and functions for kernel related errors and exceptions. + +Authors: + +* Brian Granger +* Min RK +""" from __future__ import print_function import sys @@ -12,7 +18,7 @@ __docformat__ = "restructuredtext en" __test__ = {} #------------------------------------------------------------------------------- -# Copyright (C) 2008 The IPython Development Team +# Copyright (C) 2008-2011 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. diff --git a/IPython/parallel/factory.py b/IPython/parallel/factory.py index d287ba3..cd3b426 100644 --- a/IPython/parallel/factory.py +++ b/IPython/parallel/factory.py @@ -1,4 +1,9 @@ -"""Base config factories.""" +"""Base config factories. + +Authors: + +* Min RK +""" #----------------------------------------------------------------------------- # Copyright (C) 2010-2011 The IPython Development Team diff --git a/IPython/parallel/tests/clienttest.py b/IPython/parallel/tests/clienttest.py index b6c2ed0..4ca0a24 100644 --- a/IPython/parallel/tests/clienttest.py +++ b/IPython/parallel/tests/clienttest.py @@ -1,4 +1,9 @@ -"""base class for parallel client tests""" +"""base class for parallel client tests + +Authors: + +* Min RK +""" #------------------------------------------------------------------------------- # Copyright (C) 2011 The IPython Development Team diff --git a/IPython/parallel/tests/test_asyncresult.py b/IPython/parallel/tests/test_asyncresult.py index 9457033..5d76107 100644 --- a/IPython/parallel/tests/test_asyncresult.py +++ b/IPython/parallel/tests/test_asyncresult.py @@ -1,4 +1,9 @@ -"""Tests for asyncresult.py""" +"""Tests for asyncresult.py + +Authors: + +* Min RK +""" #------------------------------------------------------------------------------- # Copyright (C) 2011 The IPython Development Team diff --git a/IPython/parallel/tests/test_client.py b/IPython/parallel/tests/test_client.py index d4e89a4..99c8105 100644 --- a/IPython/parallel/tests/test_client.py +++ b/IPython/parallel/tests/test_client.py @@ -1,4 +1,9 @@ -"""Tests for parallel client.py""" +"""Tests for parallel client.py + +Authors: + +* Min RK +""" #------------------------------------------------------------------------------- # Copyright (C) 2011 The IPython Development Team diff --git a/IPython/parallel/tests/test_db.py b/IPython/parallel/tests/test_db.py index e0b0a3d..aee3b4a 100644 --- a/IPython/parallel/tests/test_db.py +++ b/IPython/parallel/tests/test_db.py @@ -1,4 +1,9 @@ -"""Tests for db backends""" +"""Tests for db backends + +Authors: + +* Min RK +""" #------------------------------------------------------------------------------- # Copyright (C) 2011 The IPython Development Team diff --git a/IPython/parallel/tests/test_dependency.py b/IPython/parallel/tests/test_dependency.py index 9fe1604..8efdf48 100644 --- a/IPython/parallel/tests/test_dependency.py +++ b/IPython/parallel/tests/test_dependency.py @@ -1,4 +1,9 @@ -"""Tests for dependency.py""" +"""Tests for dependency.py + +Authors: + +* Min RK +""" __docformat__ = "restructuredtext en" diff --git a/IPython/parallel/tests/test_lbview.py b/IPython/parallel/tests/test_lbview.py index 9695a2e..9933e66 100644 --- a/IPython/parallel/tests/test_lbview.py +++ b/IPython/parallel/tests/test_lbview.py @@ -1,4 +1,9 @@ -"""test LoadBalancedView objects""" +"""test LoadBalancedView objects + +Authors: + +* Min RK +""" # -*- coding: utf-8 -*- #------------------------------------------------------------------------------- # Copyright (C) 2011 The IPython Development Team diff --git a/IPython/parallel/tests/test_mongodb.py b/IPython/parallel/tests/test_mongodb.py index f36e1fb..389db17 100644 --- a/IPython/parallel/tests/test_mongodb.py +++ b/IPython/parallel/tests/test_mongodb.py @@ -1,4 +1,9 @@ -"""Tests for mongodb backend""" +"""Tests for mongodb backend + +Authors: + +* Min RK +""" #------------------------------------------------------------------------------- # Copyright (C) 2011 The IPython Development Team diff --git a/IPython/parallel/tests/test_newserialized.py b/IPython/parallel/tests/test_newserialized.py index 3c3e5e6..f321acf 100644 --- a/IPython/parallel/tests/test_newserialized.py +++ b/IPython/parallel/tests/test_newserialized.py @@ -1,4 +1,9 @@ -"""test serialization with newserialized""" +"""test serialization with newserialized + +Authors: + +* Min RK +""" #------------------------------------------------------------------------------- # Copyright (C) 2011 The IPython Development Team diff --git a/IPython/parallel/tests/test_view.py b/IPython/parallel/tests/test_view.py index 036baea..b8edea3 100644 --- a/IPython/parallel/tests/test_view.py +++ b/IPython/parallel/tests/test_view.py @@ -1,4 +1,9 @@ -"""test View objects""" +"""test View objects + +Authors: + +* Min RK +""" # -*- coding: utf-8 -*- #------------------------------------------------------------------------------- # Copyright (C) 2011 The IPython Development Team diff --git a/IPython/parallel/util.py b/IPython/parallel/util.py index 42578f9..8d7ea8f 100644 --- a/IPython/parallel/util.py +++ b/IPython/parallel/util.py @@ -1,4 +1,9 @@ -"""some generic utilities for dealing with classes, urls, and serialization""" +"""some generic utilities for dealing with classes, urls, and serialization + +Authors: + +* Min RK +""" #----------------------------------------------------------------------------- # Copyright (C) 2010-2011 The IPython Development Team # diff --git a/IPython/zmq/session.py b/IPython/zmq/session.py index 7b049e9..3a10ced 100644 --- a/IPython/zmq/session.py +++ b/IPython/zmq/session.py @@ -7,6 +7,12 @@ Also defined here are utilities for working with Sessions: * A SessionFactory to be used as a base class for configurables that work with Sessions. * A Message object for convenience that allows attribute-access to the msg dict. + +Authors: + +* Min RK +* Brian Granger +* Fernando Perez """ #----------------------------------------------------------------------------- # Copyright (C) 2010-2011 The IPython Development Team