Documentation for PythonOption

[Jim Gallacher <ji...@jgassociates.ca>]

We are slowly acquiring a number of "reserved" PythonOption keywords 
which should likely be collected in one place so we don't end up with 
any name collisions. Does the PythonOption page in section 5.4.10 seem 
most appropriate? eg.

http://www.modpython.org/live/current/doc-html/dir-other-po.html

I'm thinking of something fairly simple - just a list of reserved 
keywords with a reference link to the appropriate section of the docs.

Jim

Re: Documentation for PythonOption

[Jim Gallacher <jp...@jgassociates.ca>]

Deron Meranda wrote:
> I think the namespace direction you're taking is great.  Just to be clear,
> the dotted-notation is simply that, a notation. The interface to
> req.get_options()
> is not changing is it?

You are correct, it's just a notation - req.get_options will not change.

> I also think that a listing of all the reserved or mod_python options in the
> docs for PythonOption is a very good idea.  And it should definitely be
> mentioned that the entire mod_python.* names are reserved, 

Good point.

> and that
> applications or frameworks are encouraged to implement their own
> prefix/namespaces for their own options.

And another good point. :)

I'll include your suggestions in the docs.

Thanks,
Jim

Re: Documentation for PythonOption

[Deron Meranda <de...@gmail.com>]

On 4/22/06, Graham Dumpleton <gr...@dscpl.com.au> wrote:
> Unfortunately it tends to be just you and I tossing ideas back and forth
> and when you have a two person democracy at work, hard to get some
> consensus of what is the best direction to go. :-(

I think the namespace direction you're taking is great.  Just to be clear,
the dotted-notation is simply that, a notation. The interface to
req.get_options()
is not changing is it?

I also think that a listing of all the reserved or mod_python options in the
docs for PythonOption is a very good idea.  And it should definitely be
mentioned that the entire mod_python.* names are reserved, and that
applications or frameworks are encouraged to implement their own
prefix/namespaces for their own options.
--
Deron Meranda

Re: Documentation for PythonOption

[Graham Dumpleton <gr...@dscpl.com.au>]

On 23/04/2006, at 6:29 AM, Jim Gallacher wrote:

> We are slowly acquiring a number of "reserved" PythonOption  
> keywords which should likely be collected in one place so we don't  
> end up with any name collisions. Does the PythonOption page in  
> section 5.4.10 seem most appropriate? eg.
>
> http://www.modpython.org/live/current/doc-html/dir-other-po.html
>
> I'm thinking of something fairly simple - just a list of reserved  
> keywords with a reference link to the appropriate section of the docs.

Documenting them in one central spot is probably a good idea. As far as
collisions go, if we can sort out:

   http://issues.apache.org/jira/browse/MODPYTHON-127

and then document that "mod_python" prefix is reserved and that users
are encouraged to always use their own distinct prefix, shouldn't be as
big an issue.

Unfortunately it tends to be just you and I tossing ideas back and forth
and when you have a two person democracy at work, hard to get some
consensus of what is the best direction to go. :-(

Graham