added python docstring for module; thanks to Sebastian Walter for the suggestion

darcs-hash:20100712233339-c8de0-b8da98e494e6441fec52320cbc5408ad83d956d2.gz

diff --git a/swig/nlopt.i b/swig/nlopt.i
index 4bc5587b3bb715727ca31f47289cc982c906ccbc..5645f4210bfe134947a2c8505f0a2573f221e8c1 100644 (file)
--- a/swig/nlopt.i
+++ b/swig/nlopt.i
@@ -1,5 +1,13 @@
 // -*- C++ -*-
-%module nlopt
+
+%define DOCSTRING
+"NLopt is a multi-language library for nonlinear optimization (local or
+global, with or without derivatives, and supporting nonlinear
+constraints).  Complete documentation, including a Python tutorial,
+can be found at the NLopt web page: http://ab-initio.mit.edu/nlopt"
+%enddef
+
+%module(docstring=DOCSTRING) nlopt
 %{
 #include "nlopt.hpp"
 %}