docstring

feedinlib/models.py

@@ -4,6 +4,7 @@
 
 @author: dozeumwic
 """
+
 import numpy as np
 import pandas as pd
 import pvlib
@@ -15,38 +16,6 @@ class Photovoltaic:
 
     The calculation is based on the library pvlib [1]_.
 
-    Parameters
-    ----------
-    var1 : array_like
-        Array_like means all those objects -- lists, nested lists, etc. --
-        that can be converted to an array.  We can also refer to
-        variables like `var1`.
-    var2 : int
-        The type above can either refer to an actual Python type
-        (e.g. ``int``), or describe the type of the variable in more
-        detail, e.g. ``(N,) ndarray`` or ``array_like``.
-    Long_variable_name : {'hi', 'ho'}, optional
-        Choices in brackets, default first when optional.
-
-    Attributes
-    ----------
-
-    Attributes that are properties and have their own docstrings
-    can be simply listed by name
-
-    place : list of strings
-        Containing the name of the state [0] and the name of the country
-    weather : instance of class Weather
-        Containing the weather data of all raster fields touching the region
-    tz : str
-        Timezone of the region
-    name : str
-        Name of the region. Default: 'No name'.
-    year : int
-        Year for the data sets of the region
-    connection : sqlalchemy.connection object
-        Containing a connection to an aktive database
-
     Other Parameters
     ----------------
     only_seldom_used_keywords : type
@@ -78,6 +47,11 @@ class Photovoltaic:
 
     And even use a greek symbol like :math:`omega` inline.
 
+    Attributes
+    ----------
+    required : list of strings
+        Containing the name of the state [0] and the name of the country
+
     References
     ----------
     Cite the relevant literature, e.g. [1]_.  You may also cite these
@@ -277,7 +251,7 @@ def get_normalized_pv_time_series(self, **kwargs):
         return data
 
 
-class WindPowerPlant():
+class WindPowerPlant:
     ''
 
     def __init__(self, required):