-
Notifications
You must be signed in to change notification settings - Fork 3
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
Update link to examples #24
Conversation
Bachibouzouk
commented
Aug 30, 2019
- Remove the old example
- Add a link to the examples in place of the removed file
- Update the link in the README
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why did you delete the simple example? Is it obsolete / included in the other tutorials?
CHANGELOG.md
Outdated
### Added | ||
- CHANGELOG | ||
|
||
### Changed | ||
- updated link to the examples/tutorials ([#24](https://github.com/OpenEnergyPlatform/oedialect/pull/24) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing closing parenthesis
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in b301e65
CHANGELOG.md
Outdated
- updated link to the examples/tutorials ([#24](https://github.com/OpenEnergyPlatform/oedialect/pull/24) | ||
|
||
### Removed | ||
- notebook example ([#24](https://github.com/OpenEnergyPlatform/oedialect/pull/24) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
dito
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in b301e65
README.md
Outdated
|
||
You can find a basic example [here](doc/example/oedialect_basic_example.ipynb). | ||
You can find tutorials and examples [here](https://github |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Link broken (due to line break)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in 9b9108b
@nesnoj I assumed it was present in the example repo. I plan to reorganize the example repo, I'll add the file there if it did not exist :) Thanks for your review :) |
I am a bit conflicted regarding the location of the examples. I would like to keep them with the code (i.e. inside the documentation) so we can implement proper doctests with travis etc. |
We can perfeclty implement doctests in the examples repository, no? As the repository examples contained already 5 files which explicitly had If we decide the examples should not be in the repository |