Address flake8 rst docstring issues

pygeo/constraints/DVCon.py

@@ -3139,6 +3139,8 @@ def addMonotonicConstraints(
         self, key, slope=1.0, name=None, start=0, stop=-1, config=None, childIdx=None, comp=None, DVGeoName="default"
     ):
         """
+        Add monotonic constraints to a given design variable.
+
         Parameters
         ----------
         key : str

pygeo/parameterization/BaseDVGeo.py

@@ -215,10 +215,12 @@ def mapXDictToDVGeo(self, inDict):
     def mapXDictToComp(self, inDict):
         """
         The inverse of :func:`mapXDictToDVGeo`, where we map the DVs to the composite space
+
         Parameters
         ----------
         inDict : dict
             The DVs to be mapped
+
         Returns
         -------
         dict
@@ -234,10 +236,12 @@ def mapXDictToComp(self, inDict):
     def mapVecToDVGeo(self, inVec):
         """
         This is the vector version of :func:`mapXDictToDVGeo`, where the actual mapping is done
+
         Parameters
         ----------
         inVec : ndarray
             The DVs in a single 1D array
+
         Returns
         -------
         ndarray
@@ -250,10 +254,12 @@ def mapVecToDVGeo(self, inVec):
     def mapVecToComp(self, inVec):
         """
         This is the vector version of :func:`mapXDictToComp`, where the actual mapping is done
+
         Parameters
         ----------
         inVec : ndarray
             The DVs in a single 1D array
+
         Returns
         -------
         ndarray
@@ -266,10 +272,12 @@ def mapVecToComp(self, inVec):
     def mapSensToComp(self, inVec):
         """
         Maps the sensitivity matrix to the composite design space
+
         Parameters
         ----------
         inVec : ndarray
             The sensitivities to be mapped
+
         Returns
         -------
         ndarray

pygeo/parameterization/DVGeoCST.py

@@ -286,7 +286,7 @@ def addPointSet(self, points, ptName, boundTol=1e-10, **kwargs):
         boundTol : float, optional
             Small absolute deviation by which the airfoil coordinates can exceed the initial
             minimum and maximum x coordinates, by default 1e-10.
-        kwargs
+        \*\*kwargs
             Any other parameters are ignored.
         """
         # Convert points to the type specified at initialization (with isComplex) and store the points
@@ -556,7 +556,7 @@ def totalSensitivity(self, dIdpt, ptSetName, comm=None, **kwargs):
             If you have many to do, it is faster to do many at once.
         ptSetName : str
             The name of set of points we are dealing with
-        kwargs
+        \*\*kwargs
             Any other parameters ignored, but this is maintained to allow the same
             interface as other DVGeo implementations.
 
@@ -691,7 +691,7 @@ def totalSensitivityProd(self, vec, ptSetName, **kwargs):
               values are the derivative seeds of the corresponding design variable.
         ptSetName : str
             The name of set of points we are dealing with
-        kwargs
+        \*\*kwargs
             Any other parameters ignored, but this is maintained to allow the same
             interface as other DVGeo implementations.
 
@@ -799,7 +799,7 @@ def update(self, ptSetName, **kwargs):
         ptSetName : str
             Name of point-set to return. This must match ones of the
             given in an :func:`addPointSet()` call.
-        kwargs
+        \*\*kwargs
             Any other parameters ignored, but this is maintained to allow the same
             interface as other DVGeo implementations.
 
@@ -1207,7 +1207,7 @@ def plotCST(upperCoeff, lowerCoeff, N1=0.5, N2=1.0, nPts=100, ax=None, **kwargs)
             Number of coordinates to compute on each surface.
         ax : matplotlib Axes, optional
             Axes on which to plot airfoil.
-        **kwargs
+        \*\*kwargs
             Keyword arguments passed to matplotlib.pyplot.plot
 
         Returns

pygeo/parameterization/DVGeoSketch.py

@@ -83,6 +83,7 @@ def addCompositeDV(self, dvName, ptSetName=None, u=None, scale=None, comm=None):
         """
         Add composite DVs. Note that this is essentially a preprocessing call which only works in serial
         at the moment.
+
         Parameters
         ----------
         dvName : str
@@ -168,11 +169,13 @@ def convertDictToSensitivity(self, dIdxDict):
         convertSensitivityToDict(); it transforms the dictionary back
         into an array. This function is important for the matrix-free
         interface.
+
         Parameters
         ----------
         dIdxDict : dictionary
            Dictionary of information keyed by this object's
            design variables
+
         Returns
         -------
         dIdx : array
@@ -193,6 +196,7 @@ def convertSensitivityToDict(self, dIdx, out1D=False, useCompositeNames=False):
         """
         This function takes the result of totalSensitivity and
         converts it to a dict for use in pyOptSparse
+
         Parameters
         ----------
         dIdx : array
@@ -205,6 +209,7 @@ def convertSensitivityToDict(self, dIdx, out1D=False, useCompositeNames=False):
             Whether the sensitivity dIdx is with respect to the composite DVs or the original DVGeo DVs.
             If False, the returned dictionary will have keys corresponding to the original set of geometric DVs.
             If True,  the returned dictionary will have replace those with a single key corresponding to the composite DV name.
+
         Returns
         -------
         dIdxDict : dictionary