Fix links in Python README.md files #1696
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Jingru923
requested changes
Aug 6, 2024
python/ribasim/README.md
Outdated
| @@ -13,8 +13,8 @@ setup is fully reproducible. | |||
| The package is [registered in PyPI](https://pypi.org/project/ribasim/) and can therefore | |||
| be installed with `pip install ribasim`. | |||
|
|
|||
| For documentation please see the [examples](https://deltares.github.io/Ribasim/python/examples.html) and [API reference](https://deltares.github.io/Ribasim/python/reference/). | |||
| For documentation please see the https://deltares.github.io/Ribasim/. | |||
There was a problem hiding this comment.
Suggested change
| For documentation please see the https://deltares.github.io/Ribasim/. | |
| For documentation please see the https://deltares.github.io/Ribasim/ and [API reference](https://deltares.github.io/Ribasim/reference/python/) |
There was a problem hiding this comment.
I think we should attach the link to our API, because it's useful for many people. Having a link is quite convenient.
There was a problem hiding this comment.
Ok, done. Main reason I removed it is because then it is less likely to break. Though this shouldn't change too often anyway.
Co-authored-by: Jingru923 <[email protected]>
Jingru923
approved these changes
Aug 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1686