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

Streamline docs for DSD #198

Open
6 of 16 tasks
xldeltares opened this issue Oct 18, 2024 · 2 comments
Open
6 of 16 tasks

Streamline docs for DSD #198

xldeltares opened this issue Oct 18, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@xldeltares
Copy link
Collaborator

xldeltares commented Oct 18, 2024

Version checks

  • I have checked that the issue still exists on the latest versions

Kind of issue

Docs are wrong

Documentation problem

Some docs can be updated to match the latest release:

Requests from Edward Melger:

  • update "Delft3D FM" in all texts (proper capitalization and no dash), for instance in init.py, this is also incorrect in the grey bar of pypi
  • update "HydroMT" in all texts (proper capitalization), for instance in init.py, this is also incorrect in the grey bar of pypi
  • update general hydromt description in readme.md to include "hydrodynamics" and not only "hydrology"
@xldeltares xldeltares added the documentation Improvements or additions to documentation label Oct 18, 2024
@shartgring
Copy link
Collaborator

See also #201

@shartgring shartgring mentioned this issue Nov 6, 2024
5 tasks
@shartgring
Copy link
Collaborator

shartgring commented Nov 6, 2024

I have gone through the docs to change hydromt -> HydroMT and Delft3D-FM -> Delft3D FM. I cannot do it on pypi so I created a separate issue for that such that we do not forget it, see #203. I am doing this in the branch dsd-24-docs. Also updated the readme

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

No branches or pull requests

2 participants