RE: Why I use private variables (WAS: RE:"private" variables a.k.a. name mangling?)

From: Jeremy Bowers (jerf_at_jerf.org)
Date: 01/24/05 

Date: Mon, 24 Jan 2005 11:45:34 -0500

On Mon, 24 Jan 2005 15:35:11 -0600, Philippe C. Martin wrote:

> The real reason behind my using private variables is so they do not appear
> in the epydoc generated documentation and confuse my users.

You mean single or double underscores? I just checked and at least epydoc
2.1 doesn't include single-underscore values, but those aren't "private"
in sense we're talking in this thread (some form of compiler enforcement).

Relevant Pages

  • Can Epydoc exclude wxPython?
    ... The problem is that I can't seem to instruct Epydoc to not also generate partial documentation of wxPython, which makes too much verbiage for a user to wade through in order see the documentation of my program. ... I've tried using the "exclude" command in a config file and command line and also sprinkling around "@undocumented" commands in the .py file. ...
    (comp.lang.python)
  • Re: Python HTML Documentation Generators
    ... > very familiar with Javadoc). ... > I've pretty much narrowed it to either PythonDoc or epydoc, ... It is nice because you can create documentation wich ... I have not used PythonDoc, ...
    (comp.lang.python)
  • Re: Javadoc style python manual?
    ... Though I love to learn python, I'm not very comfortable with the python ... I was going to recommend running something like epydoc over the ... Python does not rely heavily on inheritance like Java does. ... Generating API documentation using epydoc really shows this aspect of ...
    (comp.lang.python)
  • Re: Epydoc - Documenting class members?
    ... > Doxygen does not support Python - it only works for C-like languages ... you're just going to have to speak French. ... Perhaps, more to the point, I didn't write epydoc, ... for generating HTML documentation sets depended on the ...
    (comp.lang.python)
  • Re: Tried Ruby (or, "what Python *really* needs" or "perldoc!")
    ... I was under the impression that pydoc already interpreted ... documentation sets -- that's where epydoc (which I suppose ... would be cool is if some of happydoc's unique features were ... ported to epydoc (such as getting information from comments ...
    (comp.lang.python)