Curate samples

[PragTob]

I believe it would be good to curate the samples before the rc1 is released. People will look at samples to get a grasp of shoes, therefore they should be as understandable as possible :-)

What do I mean by curate?

• Make them clearer to understand - rename some variables/methods or maybe even extract some methods or eventually add some comments.
• make the sample names clearer - nobody knows what sample15 is, but with a better name one might know that. If you rename them make sure to also rename them in samples/README
• Delete duplicated samples - over time for one reason we amassed some samples that essentially do the same, find them and delete one of them!

Thanks!

[plexus]

👍

On 25 July 2013 11:27, Tobias Pfeiffer notifications@github.com wrote:

I believe it would be good to curate the samples before the rc1 is
released.

What do I mean by curate? Make them clearer to understand. So e.g. rename
some variables/methods or maybe even extract some methods. Also eventually
add some comments.

People will look at samples to get a grasp of shoes, therefore they should
be as understandable as possible :-)

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/353
.

[rjack1201]

Would this include renaming the files themselves to something more meaningful than samplexx.rb?

[fism88]

Renaming the files would be extremely helpful too with trying out the samples and learning from them

[PragTob]

Yeah right on! Just like the other simple-, good- and expert-* :-) You are of course right, samplexx.rb isn't quite the best naming :-D

[fism88]

What are the requirements for a sample file name to be prefixed with simple, good, or expert? I assume simple is low complexity and expert is high, but I'm not sure about good.

[PragTob]

I would say good is in the middle ;-) However I would not worry about renaming samples too much right now. We've more important stuff to do to get an alpha out atm :-)

[plexus]

Might be worth including choes-contrib in this discussion. Most of the samples are also included there. Do we want to keep it as a separate project?

[wasnotrice]

I took some first steps toward cleaning up samples in 803fa5c. Also opened issues for all the samples I could find that weren't working properly. We still could use some renaming and elimination of duplicates.

Another task here is to guide us away from the "adjusted" samples so that we can run their unadjusted friends. We are close on many of these. I believe these were originally adjusted by @ashbb for green_shoes.

Even another way to help would be to collect a set of screenshots of working samples (even Shoes 3 snapshots???), so that someone new to the project could verify that the sample is functioning as expected. Some of them are...surprising.

[plexus]

The simple/good/expert distinction still stems from _why IIRC. It's a bit
arbitrary. There's a browser app in shoes-contrib that allows you to run
these, and it shows them as three categories. We don't necessarily have to
stick to this naming.
On 02 Jan 2014 19:28, "Eric Watson" notifications@github.com wrote:

I took some first steps toward cleaning up samples in 803fa5chttps://github.com/shoes/shoes4/commit/803fa5ceb3bebdd7f1375f4361fcc75342fdabcf.
Also opened issues for all the samples I could find that weren't working
properly. We still could use some renaming and elimination of duplicates.

Another task here is to guide us away from the "adjusted" samples so that
we can run their unadjusted friends. We are close on many of these. I
believe these were originally adjusted by @ashbbhttps://github.com/ashbbfor green_shoes.

Even another way to help would be to collect a set of screenshots of
working samples (even Shoes 3 snapshots???), so that someone new to the
project could verify that the sample is functioning as expected. Some of
them are...surprising.

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/353#issuecomment-31490538
.

[PragTob]

👍 on getting the adjusted ones out there :-)Dunno if they were adjusted for green-shoes, quite some of them were adjusted for shoes4 specifically.

Also tehre are some snapshots already in the snapshots folder, I agree that screenshots would be good!

[PragTob]

Also there are some duplicated ones in there (clocks, calculators, the font example) - get those out as well :)

[PragTob]

Updated to be more clear about what's happening and added the Newcomer Friendly tag