search

sandiegopython / intro-to-python

Introduction to Python (2014)
Creative Commons Attribution 4.0 International
28 stars 26 forks source link

Link to official Python Tutorial docs #9

Closed willingc closed 10 years ago

willingc commented 10 years ago

This is a reminder (mainly for me) to check where would be a good spot to add a link to the official Python Tutorial https://docs.python.org/3.4/tutorial/index.html

I did a quick search of the repo and didn't see it included. Seems reasonable to include.

treyhunner commented 10 years ago

I often find the search feature on the Python Documentation website nearly unusable. I think we should link to it but note that searching the documentation might be better done from a search engine (with site:docs.python.org if necessary but even just putting python in your search usually works).

I do think that we should at least link to the relevant documentation for strings, lists, dictionaries, sets, and list comprehensions (and any other important topics). Using help(...) from the command line works but I almost always go straight to the documentation in a web browser (via a DDG/Google search) to find what I'm looking for.

willingc commented 10 years ago

@treyhunner I agree about the search feature. The one thing that I like about providing the above link and encouraging people to bookmark it is that the link takes a new developer to a table of contents that essentially hits the high points of the language. When one is new, I think that there are two flavors of information folks seek: 1) searching (i.e. your google suggested route) for a specific function/module, and 2) some context of how all these things fit together as a whole. In 2) when the user sees the table of contents days after leaving this workshop, I hope that the lightbulb moment hits the user: oh wow, I remember talking about this, and this, and that.

I added links in Part 3 to the Python docs section for random and randint. Seems reasonable aid to the presenter if questions come up from audience.

treyhunner commented 10 years ago

@willingc I agree. Browsing that table of contents could be really helpful for a beginner to get a feel for what's in Python and what they can go to the documentation for.

macro1 commented 10 years ago

Do we have anything like a resource area? We could provide links to the notebooks, related tutorials, learn python the hard way, other related resources. Like a gateway for the online resources for the event.

audreyfeldroy commented 10 years ago

I was going to cover further resources in Conclusion (formerly Part 5) as well. But if anyone feels ambitious and wants to create a web page with links, please do and I can mention it in Conclusion.

willingc commented 10 years ago

Closing this issue since original reminder is addressed in PR #41. :cookie: