Re: [Tutor] Does the Python way of doing things have a definite preference for the structure and content of program file header comments?

2015-01-24 Thread Steven D'Aprano
On Fri, Jan 23, 2015 at 12:10:38AM -0600, boB Stepp wrote: > On Thu, Jan 22, 2015 at 5:45 PM, Steven D'Aprano wrote: > > On Thu, Jan 22, 2015 at 03:17:58PM -0600, boB Stepp hid the following > > question in the subject line: > > > > "Does the Python way of doing things have a definite preference f

Re: [Tutor] Does the Python way of doing things have a definite preference for the structure and content of program file header comments?

2015-01-23 Thread Alan Gauld
On 23/01/15 06:10, boB Stepp wrote: As far as version control, I consider it *absolutely essential* for anyone who is serious about programming professionalism. stated direction, but finding time to become proficient in such a tool in the midst of all the other things I am trying to absorb is

Re: [Tutor] Does the Python way of doing things have a definite preference for the structure and content of program file header comments?

2015-01-23 Thread Alan Gauld
On 23/01/15 07:02, Ben Finney wrote: An example:: # -*- coding: utf-8 -*- # foo/frob.py # Part of FooBar, a garden gnome decoration library. # # Copyright © 2011–2015 Ben Finney # # This is free software: you may copy, modify, and/or distribute this work

Re: [Tutor] Does the Python way of doing things have a definite preference for the structure and content of program file header comments?

2015-01-22 Thread Ben Finney
Ben Finney writes: > I would consider it good practice to have a copyright statement and a > grant of license at the top; a handful of lines should suffice. > […] > But none of that belongs in the docstring. > > […] > There is PEP 257 https://www.python.org/dev/peps/pep-0257/> which > defines the

Re: [Tutor] Does the Python way of doing things have a definite preference for the structure and content of program file header comments?

2015-01-22 Thread Ben Finney
boB Stepp writes: > Does the Python way of doing things have a definite preference for the > structure and content of program file header comments? To my knowledge, the term “program file header comments” for Python would best describe a module docstring; not a comment, but documentation https:/

Re: [Tutor] Does the Python way of doing things have a definite preference for the structure and content of program file header comments?

2015-01-22 Thread boB Stepp
On Thu, Jan 22, 2015 at 5:45 PM, Steven D'Aprano wrote: > On Thu, Jan 22, 2015 at 03:17:58PM -0600, boB Stepp hid the following > question in the subject line: > > "Does the Python way of doing things have a definite preference for the > structure and content of program file header comments?" > >

Re: [Tutor] Does the Python way of doing things have a definite preference for the structure and content of program file header comments?

2015-01-22 Thread boB Stepp
On Thu, Jan 22, 2015 at 5:25 PM, Ben Finney wrote: > boB Stepp writes: > >> And […] > > Could you write a message body that asks the question? (The Subject > field isn't part of the message body.) Does the Python way of doing things have a definite preference for the structure and content of pro

Re: [Tutor] Does the Python way of doing things have a definite preference for the structure and content of program file header comments?

2015-01-22 Thread Steven D'Aprano
On Thu, Jan 22, 2015 at 03:17:58PM -0600, boB Stepp hid the following question in the subject line: "Does the Python way of doing things have a definite preference for the structure and content of program file header comments?" and then wrote: > And will this vary depending on whether a versio

Re: [Tutor] Does the Python way of doing things have a definite preference for the structure and content of program file header comments?

2015-01-22 Thread Ben Finney
boB Stepp writes: > And […] Could you write a message body that asks the question? (The Subject field isn't part of the message body.) As it is, I'm not sure what in particular you're asking about. -- \ “Are you thinking what I'm thinking, Pinky?” “Uh... yeah, | `\ Brain, but

Re: [Tutor] Does the Python way of doing things have a definite preference for the structure and content of program file header comments?

2015-01-22 Thread Alan Gauld
On 22/01/15 21:17, boB Stepp wrote: And will this vary depending on whether a version control system is being used or not? Or is the use of a version control system considered to be highly recommended (if not mandatory)? Virtually nothing in Python is mandatory - unless you plan on putting you

[Tutor] Does the Python way of doing things have a definite preference for the structure and content of program file header comments?

2015-01-22 Thread boB Stepp
And will this vary depending on whether a version control system is being used or not? Or is the use of a version control system considered to be highly recommended (if not mandatory)? -- boB ___ Tutor maillist - Tutor@python.org To unsubscribe or cha