refactor(docs): mf6 classes and codegen templates#2593
Conversation
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## develop #2593 +/- ##
===========================================
+ Coverage 55.5% 72.5% +16.9%
===========================================
Files 644 667 +23
Lines 124135 128669 +4534
===========================================
+ Hits 68947 93307 +24360
+ Misses 55188 35362 -19826
🚀 New features to boost your workflow:
|
wpbonelli
left a comment
There was a problem hiding this comment.
thanks for this!
CI failure is unrelated, it's a particle tracking thing. should be fixed soon enough.
Mark TODO for a Dfn bug with "items" in the "children" filter (issue not raised yet, but will be described soon)
yeah, this code generation stuff is now consuming a new TOML format for DFNs which is still not really hammered out yet. but its coming from devtools. we froze the version recently to avoid churn. you may want to raise the issue on devtools, unless it's also relevant here?
|
I'm only partway narrowing down the issue, but the issue is connected to recent dfn additions to modflow6 that trace to devtools that break code generation from flopy. So it's a bit all over the place. |
I just meant to warn you that any DFN oddities you see here may not be changes to dfns in modflow6, rather more likely related to our monkeying around in devtools.
Yes. Things to be kept in sync across several repos. Painful, but temporary |
This makes base mf6 classes and in the jinja codegen template docstrings more consistent, among other changes detailed here:
autoclass_contentis 'class', thus class docs are rendered preferentially over init docs). Keep a short docstring for init, which does not get rendered by Spinx, but satisfies (e.g.) D107.Filters(inflopy.mf6.utils.codegen.filters), since it wasn't used as an OOP class; only minor changes to the filter functions were required (e.g. renaming variables to distinguish them from functions with the same name).generate_classescommand to allow--no-verboseto turn off verbose (default remains with--verboseon).