Update waterdynamics.py

[rodpollet]

Added first-order Legendre polynomial option

Changes made in this Pull Request:

• a new argument (order) can be set to 1 or 2 (default) to choose between first-order Legendre polynomial (just x) or second-order Legendre polynomial (1/2 (3x²-1))
• lg1 function created
• exception raised if order not equal to 1 or 2

PR Checklist

• Tests?
• Docs?
• CHANGELOG updated?
• Issue raised/referenced?

[pep8speaks]

Hello @rodpollet! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file waterdynamics/tests/test_waterdynamics.py:

Line 58:1: E302 expected 2 blank lines, found 1

• In the file waterdynamics/waterdynamics.py:

Line 65:80: E501 line too long (101 > 79 characters)
Line 93:80: E501 line too long (112 > 79 characters)

Comment last updated at 2024-04-29 17:58:26 UTC

[orbeckst]

@rodpollet I'll have a look but if I haven't done anything next week please ping me.

[orbeckst]

Thank you for your contribution @rodpollet .

Could you please do the following:

• add yourself to AUTHORS.md
• add an entry to CHANGELOG.md under unreleased.
• add a test for your new functionality in test_waterdynamics.py

Tests are really important because that's the only way to check if changes didn't break code.

[orbeckst]

Thanks for making changes, just rename the tests. You can simply accept my suggested changes.

[codecov]

Codecov Report

Attention: Patch coverage is 92.85714% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 95.42%. Comparing base (a30f466) to head (c239815).

Additional details and impacted files

[orbeckst]

Thank you @rodpollet !