From 4ac53e032112d6dc704eaf693ec003a13cdf4f40 Mon Sep 17 00:00:00 2001
From: Sabet Seraj <48863473+sseraj@users.noreply.github.com>
Date: Wed, 11 Jan 2023 03:38:37 +0600
Subject: [PATCH] Updated demoDesignVars docstring (#171)

---
 pygeo/parameterization/DVGeo.py | 22 +++++++++++++---------
 1 file changed, 13 insertions(+), 9 deletions(-)

diff --git a/pygeo/parameterization/DVGeo.py b/pygeo/parameterization/DVGeo.py
index 23f6192d..06a3ce35 100644
--- a/pygeo/parameterization/DVGeo.py
+++ b/pygeo/parameterization/DVGeo.py
@@ -2992,25 +2992,29 @@ def demoDesignVars(
         ----------
         directory : str
             The directory where the files should be written.
-        includeLocal : boolean
+        includeLocal : boolean, optional
             False if you don't want to include the shape variables.
-        includeGlobal : boolean
+        includeGlobal : boolean, optional
             False if you don't want to include global variables.
-        pointSet : str
+        pointSet : str, optional
             Name of the point set to write out.
             If None, no point set output is generated.
-        CFDSolver : str
+        CFDSolver : str, optional
             An ADflow instance that will be used to write out deformed surface
-            meshes. In addition to having a DVGeo object, CFDSolver must have
-            an AeroProblem set, for example with ``CFDSolver.setAeroProblem(ap)``.
+            meshes. This instance must have as members:
+
+            1. This DVGeometry object (set using ``CFDSolver.setDVGeo``)
+            2. A mesh warping object from IDWarp (set using ``CFDSolver.setMesh``)
+            3. An AeroProblem (set using ``CFDSolver.setAeroProblem``)
+
             If CFDSolver is None, no surface mesh output is generated.
-        callBack : function
+        callBack : function, optional
             This allows the user to perform an additional task at each new design
             variable iteration. The callback function must take two inputs:
 
             1. the output directory name (str) and
             2. the iteration count (int).
-        freq : int
+        freq : int, optional
             Number of snapshots to take between the upper and lower bounds of
             a given variable. If greater than 2, will do a sinusoidal sweep.
         """
@@ -3104,7 +3108,7 @@ def demoDesignVars(
                         # Iterate counter
                         count += 1
 
-        # Reset DV's to their original values
+        # Reset DVs to their original values
         self.setDesignVars(dvDict)
 
     # ----------------------------------------------------------------------