Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue 3392 improve documentation #3474

Merged
merged 10 commits into from
Dec 6, 2023
Merged

Issue 3392 improve documentation #3474

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7aee06e
Added docstring for print_parameter_info method
AbhishekChaudharii Oct 26, 2023
be87f81
PEP8 adherence for One-line docstring
AbhishekChaudharii Oct 26, 2023
3c59897
Mentioned that arrays can be passed as values for drive cycles.
AbhishekChaudharii Oct 27, 2023
9e82990
reverted changes from 3c59897a3ef85e0753997dbb7cc9d3e1c1814835
AbhishekChaudharii Nov 29, 2023
7c5995f
value can be a 2-column array added in steps.py
AbhishekChaudharii Nov 29, 2023
53efe92
style: pre-commit fixes
pre-commit-ci[bot] Nov 29, 2023
ffd36dd
Merge branch 'pybamm-team:develop' into issue_3392_improve_documentation
AbhishekChaudharii Dec 5, 2023
efba2e0
removed cccv_ode
AbhishekChaudharii Dec 5, 2023
6b6ad0d
style: pre-commit fixes
pre-commit-ci[bot] Dec 5, 2023
0aa0358
removed cccv_ode - fix
AbhishekChaudharii Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pybamm/models/base_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,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:
Expand Down
2 changes: 1 addition & 1 deletion pybamm/step/_steps_util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class _Step:
or "resistance".
value : float
The value of the step, corresponding to the type of step. Can be a number, a
2-tuple (for cccv_ode), or a 2-column array (for drive cycles)
2-tuple (for cccv_ode), or a 2-column array. Can pass list as argument (for drive cycles)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this argument can be a list, it has to be a 2-column array.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just went to the original issue, the problem is that this comment that the value can be a 2-column array is not shown in the docs because it is not written in steps.py. So I would suggest reverting this change and adding the extra info in the docstrings of steps.py.

duration : float, optional
The duration of the step in seconds.
termination : str or list, optional
Expand Down
Loading