improve WellModel

[dbrakenhoff]

Short Description

Improve WellModel:

• rfunc=None by default which creates HantushWellModel() instance.
• [ENHANCEMENT] improve documentation of WellModel #542 improve docstring
• [ENHANCEMENT] better error message in WellModel if stress is not list #543 improve error msg if stress is not list (by moving stress handling up in init)

Question: setting rfunc to None by default, which instantiates HantushWellModel() modifies the call signature of this function. How do we deal with that (with deprecations and such)?

Checklist before PR can be merged:

• closes issue [ENHANCEMENT] improve documentation of WellModel #542, [ENHANCEMENT] better error message in WellModel if stress is not list #543
• is documented
• Format code with Black formatting
• type hints for functions and methods
• tests added / passed

[codacy-production]

Coverage summary from Codacy

Merging #570 (ed56bcf) into dev (1379345) - See PR on Codacy

Coverage variation	Diff coverage
❌ -0.12% (target: +0.00%)	4.35%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (1379345)	4910	3565	72.61%
Head commit (ed56bcf)	4918 (+8)	3565 (+0)	72.49% (-0.12%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#570)	23	1	4.35%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

[raoulcollenteur]

About the question, code that you used before still works right? And providing None never worked? So I think we can change this without any warnings?

[dbrakenhoff]

I'm not entirely sure why I asked that question anymore, as far as I can tell you're right and the new code shouldn't cause any problems.