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

What do with examples/ ? #4824

Closed
ViralBShah opened this issue Nov 16, 2013 · 5 comments
Closed

What do with examples/ ? #4824

ViralBShah opened this issue Nov 16, 2013 · 5 comments
Labels
docs This change adds or pertains to documentation

Comments

@ViralBShah
Copy link
Member

Currently, our examples are a collection of various things. This was useful in the early days when we had not much of a website, not much of a manual, no blog posts, and most importantly, no packages.

I would prefer to get rid of examples altogether by absorbing the useful parts in base, and move the rest into packages, or delete altogether.

For the examples that are truly meant to be teaching tools, they may be better off as ipython notebooks which explain different concepts and allow users to experiment, change things, run again, etc.

@JeffBezanson
Copy link
Member

I don't find anything offensive about a directory of 20 little files.
This is also #2598.

@ViralBShah
Copy link
Member Author

I do like to think that there should be a good reason for things to be included and distributed. I prefer removing things unless there is a good reason to have them there.

I'll move this into #2598. I forgot that it was still open.

@StefanKarpinski
Copy link
Member

Yeah, I don't really see the problem with the examples directory. Maybe we can get rid of some of them that are less relevant, but I think the directory can stay. It would be nice to hook examples into the tests so that we don't accidentally break them.

@ViralBShah
Copy link
Member Author

That is my point. Make the examples useful (with comments or refer to them in the docs), make sure they run in tests, keep them updated etc. I don't mind keeping the examples/ directory if we go down that path. Anyways, let's continue this in #2598.

@timholy
Copy link
Member

timholy commented Nov 16, 2013

Off-topic, but is there any interest in expanding the examples? I submitted a PR to https://github.com/andrioni/Quaternions.jl recently, not realizing it was based on something in examples/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

No branches or pull requests

4 participants