Re: pydoc vs. non-def'd methods

2013-08-22 Thread Dan Sommers
On Thu, 22 Aug 2013 06:39:48 +, Steven D'Aprano wrote: > On Thu, 22 Aug 2013 05:13:03 +, Dan Sommers wrote: >> class Spam1: >> >> def eggs(self): >> '''Return the Meaning of Life.''' >> return 42 >> >> ham = eggs >> >> >> help(Spam1) shows that ham = eggs(self)

Re: pydoc vs. non-def'd methods

2013-08-22 Thread Fábio Santos
On 22 Aug 2013 06:17, "Dan Sommers" wrote: > > Greetings, > > I'm hava a class in which there are two equally useful names for one > method. Consider this design (there are other approaches, but that's > not what my question is about): > > class Spam1: > > def eggs(self): > '''Return

Re: pydoc vs. non-def'd methods

2013-08-21 Thread Steven D'Aprano
On Thu, 22 Aug 2013 05:13:03 +, Dan Sommers wrote: > Greetings, > > I'm hava a class in which there are two equally useful names for one > method. Consider this design (there are other approaches, but that's > not what my question is about): Generally though, one name will be the canonical

Re: PyDoc - Python Documentation Plugin for Eclipse

2012-06-15 Thread Alexey Gaidamaka
On Sun, 10 Jun 2012 15:37:50 +, Alexey Gaidamaka wrote: > On Sun, 10 Jun 2012 05:02:35 -0500, Andrew Berg wrote: > >> On 6/10/2012 4:22 AM, Alexey Gaidamaka wrote: >>> Practically the plugin is a simple html archive from python >>> documentation website running >>> inside Eclipse so you can

Re: PyDoc - Python Documentation Plugin for Eclipse

2012-06-15 Thread Alexey Gaidamaka
On Sun, 10 Jun 2012 12:14:15 +0300, Alexey Gaidamaka wrote: > Greets! > > Since i'm new to Python, i've decided to create a handy plugin for > Elipse SDK which is my primary dev environment. Practically the plugin > is a simple html archive from python documentation website running > inside Ecli

Re: PyDoc - Python Documentation Plugin for Eclipse

2012-06-10 Thread Alexey Gaidamaka
On Sun, 10 Jun 2012 05:02:35 -0500, Andrew Berg wrote: > On 6/10/2012 4:22 AM, Alexey Gaidamaka wrote: >> Practically the plugin is a simple html archive from python >> documentation website running >> inside Eclipse so you can call it using Eclipse help system. As for now >> it is pretty large (

Re: PyDoc - Python Documentation Plugin for Eclipse

2012-06-10 Thread Andrew Berg
On 6/10/2012 4:22 AM, Alexey Gaidamaka wrote: > Practically the plugin is a simple html archive from python > documentation website running > inside Eclipse so you can call it using Eclipse help system. > As for now it is pretty large (~7 mb), but i'm planning to optimize it > in near future. Rath

Re: pydoc errors

2010-02-25 Thread Diez B. Roggisch
Am 25.02.10 08:54, schrieb john maclean: python version is 2.6.2 does any one else have this issue? Seen a few closed tickets for various Linux Distros but it is obvoiusly still my problem. help> modules Please wait a moment while I gather a list of all available modules... dm.c: 1640: not r

Re: pydoc enforcement.

2008-12-02 Thread J. Cliff Dyer
On Tue, 2008-12-02 at 09:38 +1100, Ken Faulkner wrote: > Hi > > Yeah, I was thinking about something at commit time for a VCS... > catch is, soo many VCS's out there. > And I wasn't thinking of the default action throwing compile errors, > but would only do that if a particular flag was given. >

Re: pydoc enforcement.

2008-12-01 Thread Ken Faulkner
Hi Yeah, I was thinking about something at commit time for a VCS... catch is, soo many VCS's out there. And I wasn't thinking of the default action throwing compile errors, but would only do that if a particular flag was given. Still, just an idea. I'm just finding more and more public modules/

Re: pydoc enforcement.

2008-12-01 Thread J. Cliff Dyer
On Sun, 2008-11-30 at 16:27 -0800, [EMAIL PROTECTED] wrote: > I've been thinking about implementing (although no idea yet *HOW*) the > following features/extension for the python compile stage and would be > interested in any thoughts/comments/flames etc. > > Basically I'm interested adding a che

Re: pydoc enforcement.

2008-12-01 Thread Richard Riley
Marc 'BlackJack' Rintsch <[EMAIL PROTECTED]> writes: > On Sun, 30 Nov 2008 16:27:07 -0800, [EMAIL PROTECTED] wrote: > >> Basically I'm interested adding a check to see if: >> 1) pydoc's are written for every function/method. > > Pylint warns for missing docstrings. > >> 2) There are entries fo

Re: pydoc enforcement.

2008-12-01 Thread Marc 'BlackJack' Rintsch
On Sun, 30 Nov 2008 16:27:07 -0800, [EMAIL PROTECTED] wrote: > Basically I'm interested adding a check to see if: > 1) pydoc's are written for every function/method. Pylint warns for missing docstrings. > 2) There are entries for each parameter, defined by some predetermined syntax.

Re: pydoc enforcement.

2008-12-01 Thread Rafe
On Dec 1, 7:27 am, "[EMAIL PROTECTED]" <[EMAIL PROTECTED]> wrote: > I've been thinking about implementing (although no idea yet *HOW*) the > following features/extension for the python compile stage and would be > interested in any thoughts/comments/flames etc. > > Basically I'm interested adding a

Re: pydoc enforcement.

2008-11-30 Thread r
I support any idea that supports python. You have my vote friend! -- http://mail.python.org/mailman/listinfo/python-list

Re: pydoc enforcement.

2008-11-30 Thread Filip Gruszczyński
Hey! If you are interested, I have written a small tool for declaring variables and attributes. It's not very sophisticated, because I have written it solely for own use. It might be useful though. You can download it from you: http://code.google.com/p/pyver/downloads/list For a small example, it

Re: PyDoc in Windows Vista

2008-08-29 Thread Tyler Shopshire
On Fri, 29 Aug 2008 07:12:28 -0700, Mike Driscoll wrote: > On Aug 28, 5:45 pm, Tyler Shopshire <[EMAIL PROTECTED]> wrote: >> I can't seem to access the pydoc sever from my web browser. I start the >> server from the command prompt and everything seems to be working fine, >> then I got tohttp://loc

Re: PyDoc in Windows Vista

2008-08-29 Thread Mike Driscoll
On Aug 28, 5:45 pm, Tyler Shopshire <[EMAIL PROTECTED]> wrote: > I can't seem to access the pydoc sever from my web browser. I start the > server from the command prompt and everything seems to be working fine, > then I got tohttp://localhost:/and it doesn't work. I also tried > starting the gr

Re: pydoc

2008-03-23 Thread John Machin
On Mar 24, 3:31 am, "Gabriel Genellina" <[EMAIL PROTECTED]> wrote: > En Sun, 23 Mar 2008 12:57:35 -0300, A Hutchison <[EMAIL PROTECTED]> escribió: > > > Any known reasons why pydoc no longer works? > > It gets confused by many timezone changes that occur this month around the > world; pydoc tries h

Re: pydoc

2008-03-23 Thread Gabriel Genellina
En Sun, 23 Mar 2008 12:57:35 -0300, A Hutchison <[EMAIL PROTECTED]> escribió: > Any known reasons why pydoc no longer works? It gets confused by many timezone changes that occur this month around the world; pydoc tries hard to please all kind of users and tracking those locale changes isn't e

Re: pydoc - how to generate documentation for an entire package?

2007-12-20 Thread Florian Diesch
kirillrd <[EMAIL PROTECTED]> wrote: > On Nov 20, 4:28 pm, Jens <[EMAIL PROTECTED]> wrote: >> On 20 Nov., 08:19, Marc 'BlackJack' Rintsch <[EMAIL PROTECTED]> wrote: >> >> > On Mon, 19 Nov 2007 10:50:28 -0800, Jens wrote: >> > > Generating documentation form code is a nice thing, but this pydoc.py >

Re: pydoc - how to generate documentation for an entire package?

2007-12-19 Thread kirillrd
On Nov 20, 4:28 pm, Jens <[EMAIL PROTECTED]> wrote: > On 20 Nov., 08:19, Marc 'BlackJack' Rintsch <[EMAIL PROTECTED]> wrote: > > > On Mon, 19 Nov 2007 10:50:28 -0800, Jens wrote: > > > Generating documentation form code is a nice thing, but this pydoc.py > > > is driving me insane - isn't there are

Re: pydoc - how to generate documentation for an entire package?

2007-11-20 Thread Jens
On 20 Nov., 08:19, Marc 'BlackJack' Rintsch <[EMAIL PROTECTED]> wrote: > On Mon, 19 Nov 2007 10:50:28 -0800, Jens wrote: > > Generating documentation form code is a nice thing, but this pydoc.py > > is driving me insane - isn't there are better way? > > Epydoc!? > > Ciao, > Marc 'BlackJack'

Re: pydoc - how to generate documentation for an entire package?

2007-11-20 Thread Jens
On 20 Nov., 08:20, "[EMAIL PROTECTED]" <[EMAIL PROTECTED]> wrote: > On Nov 19, 12:50 pm, Jens <[EMAIL PROTECTED]> wrote: > > > > > On 8 Nov., 02:46, Jens <[EMAIL PROTECTED]> wrote: > > > > I have a project/package for which I want to generate documentation > > > usingpydoc. > > > > My problem is th

Re: pydoc - how to generate documentation for an entire package?

2007-11-19 Thread [EMAIL PROTECTED]
On Nov 19, 12:50 pm, Jens <[EMAIL PROTECTED]> wrote: > On 8 Nov., 02:46, Jens <[EMAIL PROTECTED]> wrote: > > > I have a project/package for which I want to generate documentation > > usingpydoc. > > > My problem is that when I type "pydoc.py -w MyPackage" it only > > generates documentation for the

Re: pydoc - how to generate documentation for an entire package?

2007-11-19 Thread Marc 'BlackJack' Rintsch
On Mon, 19 Nov 2007 10:50:28 -0800, Jens wrote: > Generating documentation form code is a nice thing, but this pydoc.py > is driving me insane - isn't there are better way? Epydoc!? Ciao, Marc 'BlackJack' Rintsch -- http://mail.python.org/mailman/listinfo/python-list

Re: pydoc - how to generate documentation for an entire package?

2007-11-19 Thread Jens
On 8 Nov., 02:46, Jens <[EMAIL PROTECTED]> wrote: > I have a project/package for which I want to generate documentation > usingpydoc. > > My problem is that when I type "pydoc.py -w MyPackage" it only > generates documentation for the package - no modules, classes or > methods or sub-packages. Just

Re: pydoc - generating HTML docs from string input

2007-11-07 Thread [EMAIL PROTECTED]
On Nov 7, 4:47 pm, Laszlo Nagy <[EMAIL PROTECTED]> wrote: > [EMAIL PROTECTED] wrote: > > Has anyone ever tried mucking with pydoc to the point where you can > > get it to give you output from a string input? For example I'd like > > to give it a whole module to generate documentation for but all w

Re: pydoc - generating HTML docs from string input

2007-11-07 Thread Laszlo Nagy
[EMAIL PROTECTED] wrote: > Has anyone ever tried mucking with pydoc to the point where you can > get it to give you output from a string input? For example I'd like > to give it a whole module to generate documentation for but all within > a string: > > #little sample > > module_code=''' > """Modu

Re: pydoc script.py vs. pydoc scriptpy

2007-10-22 Thread Stargaming
On Sat, 20 Oct 2007 15:02:26 +, BartlebyScrivener wrote: > On Debian Etch, if ~/mypyscripts is in my bash PATH and also in > PYTHONPATH, I get the following pydoc behaviors. Maybe this is > intentional. I'm just checking to be sure I don't have something > misconfigured in my environment. > >

Re: pydoc with METH_VARGS

2007-06-25 Thread Farshid Lashkari
Stuart wrote: > I'm asking if there's some sort of commenting or input file or > something to customize the output pydoc generates. Thanks. AFAIK, there is no way to do this. However, you can edit the doc string for your function, which can include the argument list. I believe this is what most

Re: pydoc with METH_VARGS

2007-06-24 Thread Stuart
I'm asking if there's some sort of commenting or input file or something to customize the output pydoc generates. Thanks. On Jun 23, 11:00 pm, 7stud <[EMAIL PROTECTED]> wrote: > On Jun 23, 2:13 pm, Stuart <[EMAIL PROTECTED]> wrote: > > > With my Python extension module all the function definitions

Re: pydoc with METH_VARGS

2007-06-23 Thread 7stud
On Jun 23, 2:13 pm, Stuart <[EMAIL PROTECTED]> wrote: > With my Python extension module all the function definitions are with > METH_VARGS. The result being that pydoc, just puts "(...)" for the > argument list. Can I hand edit this to put the specific variable names > I want? With optional argumen

Re: PYDOC replacement. (Was:Sorting attributes by catagory)

2007-05-10 Thread Ron Adam
Nick Vatamaniuc wrote: > Thanks for the info, Ron. I had no idea pydoc was that powerful! > -Nick Change *was* to *will be*. It really needed to be re factored. ;-) Cheers, Ron -- http://mail.python.org/mailman/listinfo/python-list

Re: PYDOC replacement. (Was:Sorting attributes by catagory)

2007-05-10 Thread Nick Vatamaniuc
On May 10, 1:28 am, Ron Adam <[EMAIL PROTECTED]> wrote: > Nick Vatamaniuc wrote: > > Ron, > > > Consider using epydoc if you can. Epydoc will sort the methods and it > > will also let you use custom CSS style sheets for the final HTML > > output. Check out the documentation of my PyDBTable module.

Re: PYDOC replacement. (Was:Sorting attributes by catagory)

2007-05-09 Thread Ron Adam
Nick Vatamaniuc wrote: > Ron, > > Consider using epydoc if you can. Epydoc will sort the methods and it > will also let you use custom CSS style sheets for the final HTML > output. Check out the documentation of my PyDBTable module. > http://www.psipy.com/PyDBTable > > -Nick Vatamaniuc Hi Nick

Re: pydoc and imported modules

2007-04-25 Thread Joshua Schpok
I see. To make sure all my modules imported * are included in the pydocs, I'll add: __all__ = dir() to the end of my __init__.py file. Sometimes I implement a module with submodules, and flatten them out in __init__.py so the user sees it all as one single module. For example, module 'foobar' may

Re: pydoc and imported modules

2007-04-25 Thread Ron Adam
[EMAIL PROTECTED] wrote: > When I "from foo import *" in my __init__.py, sometimes module foo's > docs will be expanded in the pydocs. It seems to depend in what > language foo was implemented. > > For example, if you "from math import *" in your __init__.py, you will > see math's members will app

Re: Pydoc Rewrite Discussion at doc-sig list.

2007-04-14 Thread Ron Adam
Colin J. Williams wrote: > Ron Adam wrote: >> If anyone is interested in participating in discussing the details of the >> PyDoc rewrite/refactoring I've been working on, a discussion is being >> started on the doc-sig list. >> >> [EMAIL PROTECTED] >> >> The goal of this discussion will be t

Re: Pydoc Rewrite Discussion at doc-sig list.

2007-04-14 Thread Colin J. Williams
Ron Adam wrote: > If anyone is interested in participating in discussing the details of the > PyDoc rewrite/refactoring I've been working on, a discussion is being > started on the doc-sig list. > > [EMAIL PROTECTED] > > The goal of this discussion will be to get it to a final finished fo

Re: PyDoc -g call to Alt-Installed Python

2007-03-28 Thread D.Hering
On Mar 28, 3:09 am, Peter Otten <[EMAIL PROTECTED]> wrote: > D.Hering wrote: > > I have both python2.4 and 2.5 installed on a (k)ubuntu linux box. I'm > > trying to get the call to pydoc -g (pydoc server called from the > > system console) to recognize python2.5 rather than the system's > > default

Re: PyDoc -g call to Alt-Installed Python

2007-03-27 Thread Peter Otten
D.Hering wrote: > I have both python2.4 and 2.5 installed on a (k)ubuntu linux box. I'm > trying to get the call to pydoc -g (pydoc server called from the > system console) to recognize python2.5 rather than the system's > default 2.4 release. > > I've tried several different things so far, to no

Re: PyDoc and mod_python

2006-10-14 Thread John J. Lee
Fredrik Lundh <[EMAIL PROTECTED]> writes: > durumdara wrote: > > > I need to write documentation for my mod_python website, for the > > base classes, functions, modules. > > The problem, that mod_python is imported "apache" that not existing > > in the normal, pythonic way (only in Apache). > >

Re: PyDoc and mod_python

2006-10-11 Thread Fredrik Lundh
durumdara wrote: > I need to write documentation for my mod_python website, for the base > classes, functions, modules. > The problem, that mod_python is imported "apache" that not existing in > the normal, pythonic way (only in Apache). > problem in c:\test.py - ImportError: No module named _a

RE: pydoc does not like this file

2006-03-24 Thread Joram Agten
al Message- From: Jesus Rivero - (Neurogeek) [mailto:[EMAIL PROTECTED] Sent: Thursday, 23 March, 2006 19:47 To: Joram Agten Cc: python-list@python.org Subject: Re: pydoc does not like this file -BEGIN PGP SIGNED MESSAGE- Hash: SHA1 hmmm guess -w should be after python and not after py

Re: pydoc does not like this file

2006-03-23 Thread Jesus Rivero - (Neurogeek)
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 hmmm guess -w should be after python and not after pydoc: python -w c:\python24\Lib\pydoc.py .\setup.py And i also guess you are missing a command after setup.py (if you are using py2exe, that must be the command you are looking for.) so try this:

Re: pydoc, best practices, and Data class

2005-08-30 Thread Colin J. Williams
[EMAIL PROTECTED] wrote: > I have a python program that I am trying to generate documentation for. > But in one of my files I have a class called "Data", when pydoc gets to > this class it just barfs. Well more specifically it generates > documentation for only that one class in the file, it ignore

Re: pydoc - suppressing builtins?

2005-06-23 Thread Skip Montanaro
Alan> Is it possible to persuade pydoc not to include documentation for Alan> methods inherited from built-in classes? Alan> I'm sure I could qite easily write something to post-process the Alan> HTML files; just wondering if there might be an easier way. If you're going to

Re: pydoc preference for triple double over triple single quotes--anyreason?

2005-04-18 Thread Brian van den Broek
Kent Johnson said unto the world upon 2005-04-18 08:20: The puzzle for me was that if I enter my module name in the "Search for" box, it shows up in the list of results, as expected. But whether the results list entry for my module incorporates the description form my module's docstring or inst

Re: pydoc preference for triple double over triple single quotes--anyreason?

2005-04-18 Thread Kent Johnson
Brian van den Broek wrote: Kent Johnson said unto the world upon 2005-04-17 16:17: Brian van den Broek wrote: Kent Johnson said unto the world upon 2005-04-16 16:41: Brian van den Broek wrote: I've just spent a frustrating bit of time figuring out why pydoc didn't extract a description from my mod

Re: pydoc preference for triple double over triple single quotes-- anyreason?

2005-04-17 Thread Brian van den Broek
Kent Johnson said unto the world upon 2005-04-17 16:17: Brian van den Broek wrote: Kent Johnson said unto the world upon 2005-04-16 16:41: Brian van den Broek wrote: I've just spent a frustrating bit of time figuring out why pydoc didn't extract a description from my module docstrings. Even though

Re: pydoc preference for triple double over triple single quotes-- anyreason?

2005-04-17 Thread Kent Johnson
Brian van den Broek wrote: Kent Johnson said unto the world upon 2005-04-16 16:41: Brian van den Broek wrote: I've just spent a frustrating bit of time figuring out why pydoc didn't extract a description from my module docstrings. Even though I had a well formed docstring (one line, followed by a

Re: pydoc preference for triple double over triple single quotes -- anyreason?

2005-04-17 Thread Brian van den Broek
Kent Johnson said unto the world upon 2005-04-16 16:41: Brian van den Broek wrote: Hi all, I'm posting partly so my problem and solution might be more easily found by google, and partly out of mere curiosity. I've just spent a frustrating bit of time figuring out why pydoc didn't extract a descr

Re: pydoc preference for triple double over triple single quotes -- anyreason?

2005-04-16 Thread Kent Johnson
Brian van den Broek wrote: Hi all, I'm posting partly so my problem and solution might be more easily found by google, and partly out of mere curiosity. I've just spent a frustrating bit of time figuring out why pydoc didn't extract a description from my module docstrings. Even though I had a w

Re: pydoc preference for triple double over triple single quotes -- any reason?

2005-04-16 Thread Thomas Rast
Brian van den Broek <[EMAIL PROTECTED]> writes: > It turns out that I was using '''triple single quotes''' and pydoc > only pulls a description out from module docstrings that are formatted > in """triple double quotes""". I've poked about with google, and > cannot find any explanation of why pydo

Re: pydoc documentation- referred to Michele answer

2005-02-22 Thread Scott David Daniels
Liat Koski wrote: Hellow Michele, This systax is working only with bulid in modules, like 'sys' for example But not for personal programs. Am i wrong?? Can you please send me some syntax example you have? cause i'm getting syntax error that i don't know how to solve Thanks Liat Consider this: You

Re: pydoc documentation- referred to Michele answer

2005-02-22 Thread Michele Simionato
It works for any module in your path, including your current directory. Supposer you have /home/myname/mymodule.py do the following: $ cd /home/myname $ pydoc -g open the browser and you will see the documentation for mymodule.py just below the documentation for the builtin modules.

RE: pydoc documentation- referred to Michele answer

2005-02-22 Thread Liat Koski
al Message- From: Michele Simionato [mailto:[EMAIL PROTECTED] Sent: Tuesday, February 22, 2005 12:16 PM To: python-list@python.org Subject: Re: pydoc documentation $ pydoc -g M.S. -- http://mail.python.org/mailman/listinfo/python-list

Re: pydoc documentation

2005-02-22 Thread Michele Simionato
$ pydoc -g M.S. -- http://mail.python.org/mailman/listinfo/python-list