[WIP] Setup initial documentation #54
Conversation
patrickersing
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #54 +/- ##
=======================================
Coverage 99.27% 99.27%
=======================================
Files 60 60
Lines 2626 2626
=======================================
Hits 2607 2607
Misses 19 19 ☔ View full report in Codecov by Sentry. |
| This project has benefited from funding from [Vetenskapsrådet](https://www.vr.se) | ||
| (VR, Swedish Research Council), Sweden | ||
| through the VR Starting Grant "Shallow water flows including sediment transport and morphodynamics", | ||
| VR grant agreement 2020-03642 VR. | ||
|
|
||
| **Note: This repository is still in its alpha stage and anything might change at |
There was a problem hiding this comment.
Do you refer to the note about being in alpha stage or the acknowledgements?
There was a problem hiding this comment.
The alpha stage. Most parts should be relatively stable as far as I have observed, and the remaining breaking changes can be reflected by new version numbers. This should at least be the case when the package is kind of "published officially".
There was a problem hiding this comment.
Definitely, I agree. We can ditch this alpha stage note. We just got confused whether or not you meant the statement acknowledging VR.
There was a problem hiding this comment.
Sorry - I couldn't comment only on the alpha stage part since it was not changed directly in this PR 🙈
This PR creates the initial documentation for
TrixiShallowWater.jl.ToDo: