python-novice-gapminder icon indicating copy to clipboard operation
python-novice-gapminder copied to clipboard

20-style: add style guidelines

Open stuckyb opened this issue 8 years ago • 6 comments

20-style points learners to PEP8, which gives them a good resource for later consultation, but it's not a quick read for use in the context of a SC workshop. It'd be better, I think, if this section also summarized some of the most important concepts. This section would also be a nice place to include less mechanical stylistic advice, such as 1) why it's a good idea to avoid using lots of global variables; 2) DRY; 3) etc.

stuckyb avatar Jul 22 '16 19:07 stuckyb

@stuckyb a pull request with these details would be very welcome.

gvwilson avatar Jul 25 '16 18:07 gvwilson

@stuckyb are you able to do a short pull request to summarize a few key points? either as part of the main lesson, or in the "extras"?

gvwilson avatar Sep 30 '16 15:09 gvwilson

@gvwilson I can pick this up if @stuckyb can't or is unwilling to continue.

leouieda avatar Oct 05 '16 20:10 leouieda

Sure, but it's a lower priority than challenge solutions.

gvwilson avatar Oct 05 '16 21:10 gvwilson

I'll try to take a look at this some time relatively soon, but I won't have capacity for this in the next few days.

On 10/05/2016 05:02 PM, Greg Wilson wrote:

Sure, but it's a lower priority than challenge solutions.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/swcarpentry/python-novice-gapminder/issues/73#issuecomment-251798558, or mute the thread https://github.com/notifications/unsubscribe-auth/ADKD792YUffKc-5MhTvA6DGMWMR54A_Pks5qxBBcgaJpZM4JTFCy.

stuckyb avatar Oct 06 '16 05:10 stuckyb

@stuckyb OK then, I'll leave this up to you.

leouieda avatar Oct 07 '16 21:10 leouieda