diff --git a/IPython/core/inputtransformer.py b/IPython/core/inputtransformer.py index 115a5ca..24e28b1 100644 --- a/IPython/core/inputtransformer.py +++ b/IPython/core/inputtransformer.py @@ -1,3 +1,8 @@ +"""Input transformer classes to support IPython special syntax. + +This includes the machinery to recognise and transform ``%magic`` commands, +``!system`` commands, ``help?`` querying, prompt stripping, and so forth. +""" import abc import functools import re diff --git a/IPython/core/ultratb.py b/IPython/core/ultratb.py index a932ec9..5b4eeac 100644 --- a/IPython/core/ultratb.py +++ b/IPython/core/ultratb.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- """ -ultratb.py -- Spice up your tracebacks! +Verbose and colourful traceback formatting. **ColorTB** diff --git a/IPython/kernel/zmq/datapub.py b/IPython/kernel/zmq/datapub.py index 1d48ae4..9c3c5df 100644 --- a/IPython/kernel/zmq/datapub.py +++ b/IPython/kernel/zmq/datapub.py @@ -1,4 +1,4 @@ -"""Publishing +"""Publishing native (typically pickled) objects. """ #----------------------------------------------------------------------------- diff --git a/IPython/kernel/zmq/displayhook.py b/IPython/kernel/zmq/displayhook.py index 77f2002..756cb40 100644 --- a/IPython/kernel/zmq/displayhook.py +++ b/IPython/kernel/zmq/displayhook.py @@ -1,3 +1,5 @@ +"""Replacements for sys.displayhook that publish over ZMQ. +""" import sys from IPython.core.displayhook import DisplayHook diff --git a/IPython/parallel/util.py b/IPython/parallel/util.py index f914953..befc8e3 100644 --- a/IPython/parallel/util.py +++ b/IPython/parallel/util.py @@ -1,4 +1,4 @@ -"""some generic utilities for dealing with classes, urls, and serialization +"""Some generic utilities for dealing with classes, urls, and serialization. Authors: diff --git a/IPython/qt/console/completion_html.py b/IPython/qt/console/completion_html.py index 442c3ff..109a7cb 100644 --- a/IPython/qt/console/completion_html.py +++ b/IPython/qt/console/completion_html.py @@ -1,4 +1,4 @@ -"""a navigable completer for the qtconsole""" +"""A navigable completer for the qtconsole""" # coding : utf-8 #----------------------------------------------------------------------------- # Copyright (c) 2012, IPython Development Team.$ diff --git a/IPython/qt/console/completion_plain.py b/IPython/qt/console/completion_plain.py index d6b4066..c1b09a0 100644 --- a/IPython/qt/console/completion_plain.py +++ b/IPython/qt/console/completion_plain.py @@ -1,4 +1,4 @@ -"""a simple completer for the qtconsole""" +"""A simple completer for the qtconsole""" #----------------------------------------------------------------------------- # Copyright (c) 2012, IPython Development Team.$ # diff --git a/IPython/qt/console/completion_widget.py b/IPython/qt/console/completion_widget.py index b258775..cf5a61d 100644 --- a/IPython/qt/console/completion_widget.py +++ b/IPython/qt/console/completion_widget.py @@ -1,3 +1,4 @@ +"""A dropdown completer widget for the qtconsole.""" # System library imports from IPython.external.qt import QtCore, QtGui diff --git a/IPython/qt/console/ipython_widget.py b/IPython/qt/console/ipython_widget.py index 9ca180d..3122ec2 100644 --- a/IPython/qt/console/ipython_widget.py +++ b/IPython/qt/console/ipython_widget.py @@ -1,5 +1,6 @@ -""" A FrontendWidget that emulates the interface of the console IPython and - supports the additional functionality provided by the IPython kernel. +"""A FrontendWidget that emulates the interface of the console IPython. + +This supports the additional functionality provided by the IPython kernel. """ #----------------------------------------------------------------------------- diff --git a/IPython/terminal/console/completer.py b/IPython/terminal/console/completer.py index a435146..93283b6 100644 --- a/IPython/terminal/console/completer.py +++ b/IPython/terminal/console/completer.py @@ -1,3 +1,5 @@ +"""Adapt readline completer interface to make ZMQ request. +""" # -*- coding: utf-8 -*- import readline try: diff --git a/IPython/utils/zmqrelated.py b/IPython/utils/zmqrelated.py index e06e3f0..fb5e380 100644 --- a/IPython/utils/zmqrelated.py +++ b/IPython/utils/zmqrelated.py @@ -1,4 +1,4 @@ -"""utilities for checking zmq versions""" +"""Utilities for checking zmq versions.""" #----------------------------------------------------------------------------- # Copyright (C) 2013 The IPython Development Team #