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

Cleanup and structure examples #657

Closed
maxnoe opened this issue Feb 22, 2018 · 4 comments · Fixed by #2266
Closed

Cleanup and structure examples #657

maxnoe opened this issue Feb 22, 2018 · 4 comments · Fixed by #2266

Comments

@maxnoe
Copy link
Member

maxnoe commented Feb 22, 2018

I think we have too many examples in the base folder.

My proposol would be to have 3-5 basic examples that show the very basics to get started in the base folder and move anything else to subfolders to make them easier to find for people who look for certain things.

Right now, any newcomer won't really know where to start.

@kosack
Copy link
Contributor

kosack commented Mar 7, 2018

Sounds good. I think we also need to clean up those remaining examples as well. The other question is how many should be notebooks vs python code (notebook are nicer for demos, but harder to test).

@kosack
Copy link
Contributor

kosack commented Mar 7, 2018

Many of the examples are simply plotting examples, so I suggest we make a plotting subdir, and perhaps remove the very old "brainstorm" and "obselete" directories. The other option is to separate the examples into another package (like ctapipe-extras) but that may be confusing.

@kosack
Copy link
Contributor

kosack commented Oct 29, 2018

see also #739 : should have core examples as notebooks and have them render in Sphinx (as in GammaPy)

@kosack kosack modified the milestone: v0.7 Oct 29, 2018
@kosack
Copy link
Contributor

kosack commented Jan 29, 2019

fixed for notebook examples in #941 Still have to do this for regular examples.

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 a pull request may close this issue.

2 participants