Style and docstring modifications

agriyakhetarpal · Dec 12, 2023 · 55a70da · 55a70da
1 parent 53bedfd
commit 55a70da
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,7 +8,7 @@
 - Added a new unary operator, `EvaluateAt`, that evaluates a spatial variable at a given position ([#3573](https://github.com/pybamm-team/PyBaMM/pull/3573))
 - Added a method, `insert_reference_electrode`, to `pybamm.lithium_ion.BaseModel` that insert a reference electrode to measure the electrolyte potential at a given position in space and adds new variables that mimic a 3E cell setup. ([#3573](https://github.com/pybamm-team/PyBaMM/pull/3573))
 - Serialisation added so models can be written to/read from JSON ([#3397](https://github.com/pybamm-team/PyBaMM/pull/3397))
-- Added a `get_parameter_info` method for models and modified "print_parameter_info" functionality to extract all parameters and their type in a tabular and readable format ([#3361](https://github.com/pybamm-team/PyBaMM/pull/3584))
+- Added a `get_parameter_info` method for models and modified "print_parameter_info" functionality to extract all parameters and their type in a tabular and readable format ([#3584](https://github.com/pybamm-team/PyBaMM/pull/3584))
 - Mechanical parameters are now a function of stoichiometry and temperature ([#3576](https://github.com/pybamm-team/PyBaMM/pull/3576))
 
 

diff --git a/pybamm/models/base_model.py b/pybamm/models/base_model.py
@@ -423,9 +423,9 @@ def input_parameters(self):
 
     def get_parameter_info(self):
         """
-        Extract the parameter information and returns it as a dictionary.
+        Extracts the parameter information and returns it as a dictionary.
         To get a list of all parameter-like objects without extra information,
-        use `model.parameters`.
+        use :py:attr:`model.parameters`.
         """
         parameter_info = {}
         parameters = self._find_symbols(pybamm.Parameter)
@@ -448,7 +448,7 @@ def get_parameter_info(self):
         return parameter_info
 
     def print_parameter_info(self):
-        """Print parameter information in a formatted table from the list of tuples"""
+        """Print parameter information in a formatted table from a dictionary of parameters"""
         info = self.get_parameter_info()
         max_param_name_length = 0
         max_param_type_length = 0