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

Update link to examples #24

Merged
merged 5 commits into from
Aug 30, 2019
Merged

Update link to examples #24

merged 5 commits into from
Aug 30, 2019

Conversation

Bachibouzouk
Copy link
Contributor

  • Remove the old example
  • Add a link to the examples in place of the removed file
  • Update the link in the README

Copy link
Contributor

@nesnoj nesnoj left a 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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing closing parenthesis

Copy link
Contributor Author

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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dito

Copy link
Contributor Author

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
Copy link
Contributor

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)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 9b9108b

@Bachibouzouk
Copy link
Contributor Author

Why did you delete the simple example? Is it obsolete / included in the other tutorials?

@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 :)

@Bachibouzouk Bachibouzouk requested a review from nesnoj August 30, 2019 11:25
@Bachibouzouk Bachibouzouk merged commit 76bd074 into develop Aug 30, 2019
@Bachibouzouk Bachibouzouk deleted the fix/link-to-examples branch August 30, 2019 12:48
@MGlauer
Copy link
Contributor

MGlauer commented Aug 30, 2019

Why did you delete the simple example? Is it obsolete / included in the other tutorials?

@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.
The problem is examples that work directly on the OEP (e.g. via hard-coded urls). It might be a bad idea to include those in automated tests.

@Bachibouzouk
Copy link
Contributor Author

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 oedialect in their names and because of issue #9 I thought it would be simpler to move the example where the majority of the file lies already.

If we decide the examples should not be in the repository examples, then we might also consider moving the examples back into their own repos (i.e. oedialect, oeplatform) and get rid of example. I would be more inclined to keep examples now that it was created.

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

Successfully merging this pull request may close these issues.

3 participants