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.

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

Reorganised functions.py and updated functions.rst #1628

Merged
merged 5 commits into from
Aug 26, 2021

Conversation

partben
Copy link
Contributor

@partben partben commented Aug 26, 2021

Description

Reformatted functions.py so that everything is in alphabetical order, and updated functions.rst so that it includes everything in functions.py.

Fixes #1623

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ flake8
  • All tests pass: $ python run-tests.py --unit
  • The documentation builds: $ cd docs and then $ make clean; make html

You can run all three at once, using $ python run-tests.py --quick.

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

Copy link
Sponsor Member

@brosaplanella brosaplanella left a comment

Choose a reason for hiding this comment

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

Hi Bence! Looks good, just see the comment about the duplication. Happy to merge if the tests pass :).

EDIT: Also, can you add a line to the CHANGELOG with the changes you have done?

docs/source/expression_tree/functions.rst Outdated Show resolved Hide resolved
Remove duplicate line
Removed empty line
Update the changelog
@partben
Copy link
Contributor Author

partben commented Aug 26, 2021

The changelog should now be updated as well.

CHANGELOG.md Outdated Show resolved Hide resolved
@brosaplanella brosaplanella marked this pull request as ready for review August 26, 2021 12:20
@codecov
Copy link

codecov bot commented Aug 26, 2021

Codecov Report

Merging #1628 (c3105e3) into develop (00a9357) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##           develop    #1628    +/-   ##
=========================================
  Coverage    99.26%   99.26%            
=========================================
  Files          326      343    +17     
  Lines        18529    18677   +148     
=========================================
+ Hits         18392    18540   +148     
  Misses         137      137            
Impacted Files Coverage Δ
pybamm/expression_tree/functions.py 100.00% <100.00%> (ø)
pybamm/parameters/parameter_sets.py 100.00% <0.00%> (ø)
...electrolyte_exchange_current_density_ORegan2021.py 100.00% <0.00%> (ø)
...ORegan2021/nmc_LGM50_entropic_change_ORegan2021.py 100.00% <0.00%> (ø)
...c_ORegan2021/nmc_LGM50_heat_capacity_ORegan2021.py 100.00% <0.00%> (ø)
...electrolyte_exchange_current_density_ORegan2021.py 100.00% <0.00%> (ø)
...gan2021/graphite_LGM50_heat_capacity_ORegan2021.py 100.00% <0.00%> (ø)
...n2021/graphite_LGM50_entropic_change_ORegan2021.py 100.00% <0.00%> (ø)
...nmc_ORegan2021/nmc_LGM50_diffusivity_ORegan2021.py 100.00% <0.00%> (ø)
...GM50_ORegan2021/copper_thermal_conductivity_CRC.py 100.00% <0.00%> (ø)
... and 9 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 00a9357...c3105e3. Read the comment docs.

@valentinsulzer
Copy link
Member

@all-contributors add @partben for docs

@valentinsulzer valentinsulzer merged commit b924eca into pybamm-team:develop Aug 26, 2021
@allcontributors
Copy link
Contributor

@tinosulzer

I've put up a pull request to add @partben! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

pybamm.erf and pybamm.erfc are missing documentation
3 participants