In defense of documentation and /r/learnpython

I feel like any discussion of reddit as a source of anything requires a “defense of” perspective.  There is a traditional and justified fear of going to the internet for help, but I have been pleasantly surprised at the /r/learnpython community.  Perhaps it is because the entire purpose of this group is for newbies to ask newbie questions that participants of the community are so kind.  Having /r/python as a separate group is also helpful.

Any student new to a domain needs to find a learning community.  This may be a friend who knows the topic, classmates, or internet forums.  Given the small number of Python communities out there in physical space, having virtual communities is often the only recourse.

Why do I find that /r/learnpython is a pretty awesome group?  Mostly, everyone is really nice.  We all need supportive and nice communities and tutors. Being afraid to ask a question prevents growth.  This is not to say that you shouldn’t try to resolve things on your own.  I have often answered my own questions while trying to write them up for other people.  I never really used these resources to ask questions, because it is very rare for me to ask a question that hasn’t already been asked somewhere else.

The other important factors:

  • a solid list of resources, if not obviously organized
  • huge range of research domains represented
  • fast and kind answers

A big issue I hear reported from students, particularly from the humanities and social science crowds, is a lack of comfort when using documentation.  Their discomfort is usually communicated as something like “Looking at documentation means I don’t really understand it.”  My theory behind this is that the kind of training that we get in our coursework is just different from math/CS.  The idea of the ‘cheat sheet’ isn’t really present in our normal studies.  We read original materials, discuss them, write about them, and come away with a mastery of concepts rather than a memorization of syntax.  I would argue that items like and Python in Your Pocket are viewed by some as if they were Cliffs Notes.  This doesn’t map perfectly, but it gets my point across.  I hypothesize that the non-STEM students view referencing documentation as implying that they don’t understand the material.  I wonder if language students feel differently from this because of the need to reference dictionaries.

This is an interesting distinction between these two groups.  In programming you learn semantic concepts and study language specific syntax.  On the other side of the coin, humanities and social science students use human language our or syntax and deeply study the semantics of various theoretical domains.  Referencing syntax for this later group amounts to reviewing style guides for citation and dictionaries, but is viewed as functionally different from the semantics they are learning.  They have such a focus on semantics that syntax is often not formally distinguished.  On the other hand, to programming, semantics and syntax are (usually) taught at the same time and are intertwined.  Referencing documentation for syntax is similar to referencing how to spell a word or how to use commas.  This isn’t “cheating” because it isn’t giving you the answer and doesn’t imply weakness in understanding.

I try to focus on making these distinctions when working with students reporting this hesitation:  it is completely normal to reference documentation all the time when writing programs.  It is not giving away the answer, but just telling you how to spell your answer correctly.  You still have to come up with the answer.  There could also be an argument that looking at documentation is not only normal, but ideal.  Particularly when using syntactical forms outside your normal toolbox, or when the teaching process is focusing on the semantic forms rather than memorizing syntax.

As explained to me by my web design professor when announcing that all our exams were open book and open internet:  we are never alone when coding.  When writing a program in a professional environment you will have your books and coworkers available.  Communication, discussion, etc. are vital to the process and professional growth.  Our society introduction specialization for a reason:  there are benefits to people having deep a understanding of one particular domain, but specialization requires that we all work together.

To new students of Python or any other programming language:

  • embrace documentation
  • collect helpful documentation for your domain together
  • don’t be afraid to make annotations or notes in your reference books
  • looking at documentation doesn’t mean you don’t know what you’re doing
  • we very often answer our own questions when trying to formulate them
  • find a community and talk to your learning peers

3 thoughts on “In defense of documentation and /r/learnpython

  1. Wow, these comments on feelings about documentation are fascinating, and never would have occurred to me. (I was a math/classics major at an engineering school, so reading documentation was culturally normalized, and even in my humanities major, yes, I was constantly consulting the dictionary.)

  2. Yup, still thinking about this —

    That math/classics double? Not rare. There was at least one in every classics department I’ve ever been affiliated with. And Latinists are also incredibly common among programmers.

    Because we are, in fact, *people who like syntax*. We’re abstract symbol manipulators, we’re punsters. (When we’re musicians, there’s a good chance we’re into theory or composition more than performance.) The aesthetics of syntax and the puzzle-box challenge of mapping syntax to semantics are common problems across these domains.

    1. The division between the people who self-select into a group and those who don’t but still need to do the task is important to acknowledge in the education process and within learning materials. My stock response to people pushing me to major in CS was “Just because you can fix a toilet doesn’t mean you want to be a plumber.” I was pretty misguided about what I thought the ‘coding’ life was (leading to my adamant rejection of it), but I think it is important to recognize and validate the feelings that the non-selectors have. Coding just isn’t some people’s jam but that doesn’t mean they won’t benefit from the knowledge. These non-selectors are also less likely to have the natural inclinations that the selectors have (with those naturally occurring domain successful behaviors being a big influence on their selector status), and I think we can see that being expressed in the documentation dilemma. The fact that there are these two disparate groups is why I’m always very explicit and descriptive about the learning behaviors that lead to success in any workshop or class that I lead.

Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: