[docs] Feature request: make searching for "@" return information on decorators
Will Marler
will at wmarler.com
Sat May 17 00:38:29 CEST 2014
TL;DR: see the subject line
I'm new to Python and was reading code that used this:
@property
def ...
and I didn't know what it meant. I looked in the python.org docs for "@"
and "@property" and didn't get any results, so I turned to Google and found
a good page on stackoverflow about how "@property" worked (
http://stackoverflow.com/questions/17330160/python-how-does-the-property-decorator-work
).
However, I still did not understand "@". I eventually asked a colleague (I
try to RTFM before asking), and he said "oh ya, that's a decorator." Once I
knew that "@" = "decorator," I could search for "decorator" in the docs and
get useful results. In fact, I found a LOT of great results; this isn't a
request for more information on decorators :).
I probably spent 15-20 minutes before learning @ = decorator, and I'm sure
this is something that plagues other newbies. Can the docs (or search
functionality) be updated so someone searching on "@" as a single search
term will get information on decorators? Search results could include a
direction to the decorator entry in the glossary?, the function/class
definition pages, etc.
Thanks,
Will
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20140516/fdd3c702/attachment.html>
More information about the docs
mailing list