From: stevenj <stevenj@alum.mit.edu>
Date: Mon, 12 Jul 2010 23:33:39 +0000 (-0400)
Subject: added python docstring for module; thanks to Sebastian Walter for the suggestion
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=70773dec39b9a431a26a27e9ac621cad0c5af6d7;p=nlopt.git

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 4bc5587..5645f42 100644
--- 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"
 %}