IDEA

[Tom Enos]

Todd you have control of lighshowpi.org website,   Maybe you could add a single page (not part of the regular site) that could apprise the regular dev team of how code should be written. Not a how to add code to lightshowpi, but maybe a lets follow these guidelines sort of thing, the lint, how docstrings should be parsed, exception handling, just the basics.  The dev team could let contributors (people that make more then just one or two pull requests) know about the long term goals.  If they only contribute one or two times then we could clean up the code and credit them in full for the contribution (a clean up for docs or readability is nothing, (i would be happy to to do that and give credit someone else, the idea is what is important. not the exact implementation)). It would not change any thing we put out to the general public.  But it would give long term supporters a guide to work from, not requirements.  I watch very little TV if any, the kid are all grown, moved out, and living their own lives, (the oldest has a new live without her parents in a different state and our youngest is serving PROUDLY abroad) so I have the time to do a lot of coding for the project (documenting code and re-factors and the like), so lets get serious for the long haul.  

[Todd Giles]

Sounds like you're asking for a style guide?  I agree code is more readable and it is much easier for new developers if we adhere to one.  Seeing as python is a relatively new language for me - I'm open to suggestions from others on any particular style guide.  Seeing as I currently work at Google, I wouldn't mind using the google style guide as it would keep me in line with the style guide I would adhere to at my day job:

https://google-styleguide.googlecode.com/svn/trunk/pyguide.html

We can of course reference it (or some other guide), and make our own project additions / exceptions as desired.

I agree with you as well that this is simply a guide (not requirements per se).  It would be good for us to highly encourage others to follow it, but I'd like to lean on the side of letting any and all come in and help out versus being a style guide nazi.

Anyhow, is this generally what you are suggesting?

On Fri, Jun 26, 2015 at 2:24 AM Tom Enos <tom....@overclocked.net> wrote:

Todd you have control of lighshowpi.org website,   Maybe you could add a single page (not part of the regular site) that could apprise the regular dev team of how code should be written. Not a how to add code to lightshowpi, but maybe a lets follow these guidelines sort of thing, the lint, how docstrings should be parsed, exception handling, just the basics.  The dev team could let contributors (people that make more then just one or two pull requests) know about the long term goals.  If they only contribute one or two times then we could clean up the code and credit them in full for the contribution (a clean up for docs or readability is nothing, (i would be happy to to do that and give credit someone else, the idea is what is important. not the exact implementation)). It would not change any thing we put out to the general public.  But it would give long term supporters a guide to work from, not requirements.  I watch very little TV if any, the kid are all grown, moved out, and living their own lives, (the oldest has a new live without her parents in a different state and our youngest is serving PROUDLY abroad) so I have the time to do a lot of coding for the project (documenting code and re-factors and the like), so lets get serious for the long haul.  

--
http://www.lightshowpi.org/
---
You received this message because you are subscribed to the Google Groups "LightShow Pi Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to lightshowpi-d...@googlegroups.com.
To post to this group, send email to lightsh...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/lightshowpi-dev/9b8fde52-e03f-4be1-a1b3-5bd4a76bf23e%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Tom Enos]

https://google-styleguide.googlecode.com/svn/trunk/pyguide.html

That is exactly what I was thinking.  After reading through some of it I see I might have to change a few of the habits that I have, I HATE in line comments, they are ugly, and I have to move them ;(

Other then that I really like that guide.  And I remember reading somewhere that sphinx supported the google docstring style.  I will run a few test pages to see what it looks like.  

It would be good for us to highly encourage others to follow it, but I'd like to lean on the side of letting any and all come in and help out versus being a style guide nazi.

I totally agree, and even if we do get code that doesn't follow the guide it's no big deal.  If you haven't noticed I tend to move things around a little bit (style wise, white space, tabs to spaces, etc..) anytime I touch a file.  I got to have my white space just so I can read the file correctly.  I'm almost A.D.D. about the white space, maybe sometimes to much.

[Todd Giles]

I've added a short blurb here to indicate we're using this style guide:

https://bitbucket.org/togiles/lightshowpi/wiki/Home

Let me know what you think... I'll try to find time to make a developers page on http://lightshowpi.org/ as well, but for now it points to the above wiki page on bitbucket.

-Todd

To view this discussion on the web visit https://groups.google.com/d/msgid/lightshowpi-dev/926b190c-df4d-47bd-80e0-b06406103e2e%40googlegroups.com.

[Tom Enos]

We have a goal to follow the Google Python style guide to keep our code as readable as possible. We're not strictly following it at this point (as you'll easily find out as you read our code), but we're working to get there. All new code should adhere to it as closely as possible.

I like it, but maybe that last line is a little strong.  I would just delete that last line.

[Todd Giles]

Sounds good, removed.

To view this discussion on the web visit https://groups.google.com/d/msgid/lightshowpi-dev/590a9890-f1f5-444c-b546-10f784a7e491%40googlegroups.com.