Python docs very off-putting

This isn't just a rant, don't worry
So, I haven't been coding anything serious in quite a while... this makes me sad.
I thought, okay, I'll mess around with one of the more newfangled languages and get active in programming once more.
Python seemed the logical choice, so I gathered up some tutorials and waded in...
Until I hit the core library docs.  Ouch.
The language I (sadly) have the most experience with is Java, and while Javadocs may be painful to write, I never released how much I came to love them.
Extremely structured, precise, and thorough...
Python's docs appear to be none of these things.
There are the docs here, which at first seemed to me to be a rough overview of the libraries, but upon further inspection may actually be official definitions?  Not nearly as structured as the Javadocs, and much more painful to wade through.
There's also the documentation served up by the pydoc program.
While much more rigorous and structured in appearance, it also feels half-done; a slipshod effort.
It simply feels wrong, and every minute I spend looking at pydoc pages, I spend in discomfort.
Sounds weird, but it's true -- anyone understand what I mean?  That, and it's downright garish looking.
Perhaps it's just me?  So I went to see what kind of docs Ruby offered, and I am very pleased.
Not as good IMO as the Javadocs (and I hate praising them for some reason, but it's true xD), but that may be attributed to experience alone, and preference to the eyes; we shall see.
In any case, Ruby's docs are vastly superior to Python's.  Framed, logical, tons of examples...  fantastic.
Anyone know any alternatives to the Python doc system?  I'm very tempted to just learn Ruby right now...

All the same, I'd rather not learn an older version of Python, as little as the differences may (or may not) be, simply because the new version does not have good docs.  That doesn't speak well for the language, it implies that might be the case in future releases as well.
I'm not even sure 2.6 does have better docs.
Personally, I love the frames of the Java API   It's one of the few places I think frames serve a purpose.  Docs need to be highly structure, like the Java API is.
And while it is true that the Java API lacks a search feature, I've been able to overcome that with simple Google site-search.
But, here are some specific issues I have with the Python docs:
-) The Standard Library page is formatted like a tutorial, I feel, more than a reference.  Modules are sorted by category of function, and while that seems a minor difference from straight alphabetical listing, it already feels off to me.  And then, in the specific module pages, things just feel... loose.  Little to no examples, curosy description of each function at best.  Where the Javadocs tended to pore over specifics and edge cases for each function, Python seems to only summarize the usage.
-) The pydoc pages are downright nasty to look at, and while feeling much more like reference than the Standard Library pages...  I don't really know.  It still feels unorganized, and still feels like a poor man's documentation, so to speak.
I really wish this wasn't so feel-based, because I _want_ to enjoy Python's docs, I'm not a man on a mission to diss Python or anything xD
Is there anyone out there who feels the same as me?  Did you go on to enjoy Python somehow? 

Similar Messages

  • [svn:fx-trunk] 12911: fix doc target to put docs in flash-integration_rb swc for en_US

    Revision: 12911
    Revision: 12911
    Author:   [email protected]
    Date:     2009-12-14 12:06:29 -0800 (Mon, 14 Dec 2009)
    Log Message:
    fix doc target to put docs in flash-integration_rb swc for en_US
    QE notes: builder team should make sure code hinting works
    Doc notes: no
    Bugs: no
    Reviewer:no
    Tests run: ct
    Is noteworthy for integration: no
    Modified Paths:
        flex/sdk/trunk/frameworks/projects/flash-integration/build.xml

    Thats good news.

  • I just added two external firewire drives and they keep going to sleep.  I did not have this problem when USB.  I have turned off "put disks to sleep" in power preference.

    I just added two external firewire drives and they keep going to sleep.  I did not have this problem when using USB external drives.  I have turned off "put disks to sleep" in power preference.

    It is not clear if these are the same drives, just connected
    differently, or different drives?
    One thing that may be happening is that the drives firmware
    itself is putting it to sleep when inactive.  Many drives on
    the market have ths feature and it is turned on by default
    and require a drive utility from the manufacturer to disable it.

  • Check this Single place for all R12 Docs - Very Useful

    Check this,
    http://download.oracle.com/docs/cd/E18727_01/index.htm
    Description
    Oracle E-Business Suite is a comprehensive suite of integrated, global business applications which provides a customer focused strategy. Use this web site to search the various documentation types for Oracle EBS Applications. This web page provides access to documentation available in PDF and HTML formats. Use the tabs to locate and view Oracle EBS documentation.
    (Note: I have posted the same in OAF Forum, making it duplicate to share with a larger group)
    With regards,
    Kali.
    OSSi.

    Duplicate post -- Check this Single place for all R12 Docs - Very Useful
    Please post only once.
    Thanks!

  • Reader X opens Docs very slowly, need help

    Just upgraded to X, prior versions opened files immediately, this version takes 10-15 seconds to open, frustratingly slow.  Any recommendations to speed it back up? 
    Noticed a discussion that mentioned this version accesses internet with every file opened.  How much data is exchanged and can this be turned off?  Part of speed problem?  In rural area, I have limited data usage on wireless card.

    I have this problem too and I have since long suspected the sandbox to be the culprit. It wasn't until today that I started Googling it though. I first found this forum and now I think I have found the solution here:
    http://www.sevenforums.com/software/131325-adobe-reader-x-very-slow-open-some-pdf-under-wi ndows-7-64-bit.html
    "Go to Edit / preferences / general  - then uncheck box 'Enable protected mode at startup'   This got rid of the lag in opening adobe docs."
    I'm trying this out now! Even though it will kill what little security Adobe has created I cannot stand the lag anymore.

  • Powering speakers on/off puts rMBP to sleep.

    I have a mid-2012 rMBP running Yosemite 10.10.1
    I'm using it in clamshell mode, running one external display on HDMI, and another from thunderbolt.
    If I turn my speakers off it puts the computer to sleep and turns off the displays. This happens 90% of the time, but not every time.
    Sometimes this also happens when I turn them on, but not as often.
    This also happens if I unplug the charger from the MBP.
    Power outlet - > Surge protection (SP) with split:
    SP A: Always on -> displays, HDD's, audio interface etc.
    SP B: on/off switch -> speakers, keyboard
    This way I use the switch on the SP to turn my speakers on and off.
    If I disconnect the speakers from the switch and flip it on/off I do not get the MBP to go to sleep.
    The power to the MBP is straight from the power outlet.

    up?
    Anyone?

  • SAP FI Blueprint and doc - Very Very Urgent

    Hi SAP Gurus,
    My Company is implementing SAP ECC 6.0 and I have been assigned for the documentation for the project . Right from Blueprinting , realization till production support. I m not clear as what information do i need to gather gather from there ,
    Can you please send FI business blueprints and other information i need to have specific knowledge.
    What information do i need to gather from the end users?
    Can u give in detailed information in this.
    I'm in urgent need of business bluprint (the way to handle and structure this kind of project, things to consider etc.) I would be very grateful if someone could help me in this situation.
    Can any one of you please send me the copy of the Business Blueprint Doc
    Email : [email protected]
    Thanks

    Hi Sahil,
    Check out the links below
    http://hrnt.jhu.edu/news/files/HRForum102504x.ppt
    http://www.jhu.edu/hopkinsone/Library/Blueprint/Finance_Section9_9.pdf
    http://iris.tennessee.edu/Blueprint/Financial/Executive%20Summary.doc
    http://iris.tennessee.edu/Blueprint/Financial/Enterprise%20Structure%20&%20Master%20Data.doc
    assign points if useful
    Regards
    Genie

  • Can't take songs off puter without itunes taking same songs off ipodnano :(

    I can't keep all of my music on my puter due to space. I put CDs on my puter then onto ipod then remove CDs from puter but then when I connect, and itunes syncs, it removed previously installed CDs. I am new to ITUNES so how can I install songs onto ipod and just leave them on the ipod regardless of whats on my computer when I connect and itunes syncs?
    Thank you for your time and help.

    You can do this if you turn off automatic synchronization. Connect your iPod and go to the iPod Options and select the "Manually manage" option. It will then not automatically remove the items from the iPod if you delete them from iTunes. You'll have to drag songs and videos from your library or playlist to iPod in the Source list to add new tracks.
    Note that it's not a good idea to depend solely on your iPod to have your only copy of items that you've purchased from the iTunes Store or that would otherwise be difficult to replace. I strongly recommend that you make a backup copy of such material (on CD, DVD, or an external hard drive) before you delete it from iTunes.

  • Scanned docs - Very fuzzy, not clear

    I've never seen this before.  The document is created using a flatbed scanner.  The original is all text.  On one particular computer the text is unreadable in Reader.  The file opens, but the image is so fuzzy you can't read it.  The text looks like the resolution was blown up so much that all you see are the dots that make up the image.
    I've tried 3 other computers, and all can view the doc with no problem.  All are XP Pro.  All have the latest version of Reader.
    I tried uninstalling and re-installing Reader, even removing anything Adobe related from the Registry.
    I compared settings in the non-working computer with one that works, both are the same.
    Any idea what the problem is?

    Actually, I did.  It's the lastest version.  9.something.
    The problem PC started out with 7.something.  That didn't work so I uninstalled it and installed 9.something.  That didn't work, so I un-installed it again, and removed all instances of anything "adobe" from the Windows registry.  Then re-installed the latest version from Adobe, ran it, and got an update from Adobe.  Same problem.  I thought it might be somehow (though unlikely) hardware related.  But I can RDP into a server from this PC, and open the same PDF, and it views fine.  So it isn't a hardware issue.
    I've compared settings, and don't see any difference.  A very unusual problem.

  • 2 Page doc = very slow, almost unworkable when typing Slow slow slow...

    Did some research, latest was posted in FEB.
    What is the deal with this? The doc has some images, but they are small jpegs. It should NOT have a 1200 millisecond, or 1.2 second delay when typing.
    Its becoming very difficult to work with.
    Any ideas?

    You're not the only one with this problem. There is a long discussion, with some proposed solutions, in this thread (and searching for "slow" in the Pages forum will bring up other threads as well).

  • How to turn off "putting depending files" ?

    Is there such option in DW ? I do not upload automaticly all the related files, I just want to upload one saved file. Anyone can help?

    When Dreamweaver displays the dialog box that asks about uploading dependent files, select the "Don't show this message again" check box, and click No. Dreamweaver will remember that you don't want to put the dependent files.
    If you can't see the dialog box, go to Preferences (Edit menu on Windows, DW menu on a Mac), and select the Site category. Select the option for Prompt on put/check in, and click OK. The next time you upload a file, Dreamweaver will ask you if you want to upload dependent files. Select "Don't show this message again", and click No.

  • After updating to ios 6.1 my smart phone is useless, no signal, no sync with calendar outlook! I am very ****** off with apple! Need a solution asap! Using vodafone greece!

    Cannot sync, invitee attendess and loosing signal and 3g"
    Phone is useless!
    Anyone facing the same problems.?
    Pls help!
    I am using windows 7, pro and outlook 2003
    Apple supprt pls fix this asap!
    Cannot work!
    When does new update is available?

    Hi
    I recently updated to IOS6 (I am U.K based), the APN was changed in Cellular Data, Visual Voicemail and MMS, I changed this back to the original from my provider and now everything works as before. I don't know whether this would apply to the network in China but definately worth a try...
    Andrew

  • I want to reduce size of photos on Open Office Doc. prior to putting on a website. Any suggestions? Thanks

    I have many photos on a proposed website but I need to reduce the size ...how do I do this on Open Office before publishing or sending by email. ?
    Thanks

    Down and dusted from the replies here. Thank you

  • My touch id has been very off lately, why?

    my touch id has not been working well lately, why?

    Here's what Apple has on the Touch ID support site:
    Get help with Touch ID
    Make sure that you're using the latest version of iOS.
    Make sure that your fingers and the Home button are clean and dry.*
    Cover the Home button completely. Don't tap too quickly, don't press down hard, and don't move your finger while Touch ID is scanning. Make sure that your finger touches the metal ring around the Home button.
    If you're using a case or screen protector, make sure it doesn't cover the Home button or the surrounding ring. If it does, remove the case or screen protector and try again.
    Tap Settings > Touch ID & Passcode and make sure that iPhone Unlock or iTunes & App Store is on. Also make sure that you've enrolled one or more fingerprints.
    Try enrolling a different finger.
    If you can't enroll any of your fingers, take your device to an Apple Retail Store, Apple Authorized Service Provider, or contact AppleCare for help.
    You might want to try deleting the fingerprint that is not working well and try re-scanning it to see if the issue clears up.
    Cheers,
    GB

  • KDM: Logging off puts me in console mode

    I have a weird problem with KDM.
    Well, I run KDM from inittab using init 5. There is not conflicting entry of KDM inside rc.conf to cause an issue I had read about in this forum.
    Now, ctrl+alt+backspace shortcut is enabled to restart X. When I do it, X restarts normally the way it should and I am back in KDM window.
    But each time I use inbuilt logoff function in Xfce4.6 or KDE 4.3, I end up in console mode. Apparently I am still in init 5, because once I manually login and do a
    sudo init 5
    Nothing happens. But if I do
    sudo init 3
    I get a switching message.
    After that I do a
    sudo init 5 && exit
    So that I can get back to login manager window.
    Now, why does this happen ? I hate having to manually restart the login manager each time I use logout to switch to another user.
    And yeah, is there any theme in KDM which shows a list of users I can login as ?
    How do I ensure that only one instance of a user is logged in at a given moment and if I lock screen and go back to menu and login again, I go back to the same instance ?

    Are you, by chance, using KMS with Intel Graphics?  If so, check your /var/log/Xorg.0.log for signs that Xorg crashed when you logged out.
    If you find such evidence, you might try (As a work around):
    edit /usr/share/config/kdm/kdmrc and find the block labeled :
    [X-:*-Core]
    and add a line that reads:
    TerminateServer=true
    This forces KDM to restart the Xorg server after you log out.  I think the original purpose of this option was to force the clean up of memory leaks, but it works well for this purpose.

Maybe you are looking for

  • Restricting dashboard prompt values in obiee 11g

    Hi All, I have a requirement to restrict the length of the dasboard prompt value to min of # characters. Please let me know if you have any idea (JScript). Regards, Zameer

  • Why do colors come over as Color Book swatches when I copy and paste to a new document?

    Why do colors come over as Color Book swatches when I copy and paste to a new document? Original document has CMYK spot color swatches. I copy them and paste them in new document and it gets converted to a Color Book swatch. Why?

  • Preview very slow with .nef photos

    My preview works well for .jpg but not .nef. Open folder, select 'all' right click, open with 'preview'. Very slow & jerky. Used to work fine with .nef in Mt. Lion. Any ideas?

  • XML exception when running .jrxml

    Jun 7, 2006 9:43:01 AM org.apache.commons.digester.Digester error SEVERE: Parse Error at line 5 column 260: Element type "style" must be declared. org.xml.sax.SAXParseException: Element type "style" must be declared. at org.apache.xerces.util.ErrorHa

  • Remote desktop gateway server is unavailable

    We get this error while trying to rdp to a computer almost everyday between 6:45am-7:10AM we have confirmed that IIS pools have enable 32-bit as false. The registry key in HKLM\Software\Microsoft\Rpc\RpcProxy is set with a value of "default web site"