Issue 3392 improve documentation (pybamm-team#3474)

* Added docstring for print_parameter_info method

* PEP8 adherence for One-line docstring

* Mentioned that arrays can be passed as values for drive cycles.

* reverted changes from  3c59897

* value can be a 2-column array added in steps.py

* style: pre-commit fixes

* removed cccv_ode

* style: pre-commit fixes

* removed cccv_ode - fix

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

pybamm/models/base_model.py

@@ -421,6 +421,7 @@ def input_parameters(self):
         return self._input_parameters
 
     def print_parameter_info(self):
+        """Returns parameters used in the model"""
         self._parameter_info = ""
         parameters = self._find_symbols(pybamm.Parameter)
         for param in parameters:

pybamm/step/steps.py

@@ -120,7 +120,7 @@ def current(value, **kwargs):
     Parameters
     ----------
     value : float
-        The current value in A.
+        The current value in A. It can be a number or a 2-column array (for drive cycles).
     **kwargs
         Any other keyword arguments are passed to the :class:`pybamm.step._Step`
         class.
@@ -141,7 +141,7 @@ def c_rate(value, **kwargs):
     Parameters
     ----------
     value : float
-        The C-rate value.
+        The C-rate value. It can be a number or a 2-column array (for drive cycles).
     **kwargs
         Any other keyword arguments are passed to the :class:`pybamm.step._Step`
         class.
@@ -162,7 +162,7 @@ def voltage(value, **kwargs):
     Parameters
     ----------
     value : float
-        The voltage value in V.
+        The voltage value in V. It can be a number or a 2-column array (for drive cycles).
     **kwargs
         Any other keyword arguments are passed to the :class:`pybamm.step._Step`
         class.
@@ -183,7 +183,7 @@ def power(value, **kwargs):
     Parameters
     ----------
     value : float
-        The power value in W.
+        The power value in W. It can be a number or a 2-column array (for drive cycles).
     **kwargs
         Any other keyword arguments are passed to the :class:`pybamm.step._Step`
         class.
@@ -204,7 +204,7 @@ def resistance(value, **kwargs):
     Parameters
     ----------
     value : float
-        The resistance value in Ohm.
+        The resistance value in Ohm. It can be a number or a 2-column array (for drive cycles).
     **kwargs
         Any other keyword arguments are passed to the :class:`pybamm.step._Step`
         class.