|
Home > Archive > Apache Mod-Python > April 2006 > Documentation for PythonOption
You are viewing an archived Text-only version of the thread.
To view this thread in it's original format and/or if you want to reply to
this thread please [click here]
| Author |
Documentation for PythonOption
|
|
| Jim Gallacher 2006-04-24, 8:02 am |
| 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/curre...r-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
| |
| Graham Dumpleton 2006-04-24, 8:02 am |
|
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/curre...r-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
| |
| Deron Meranda 2006-04-27, 6:52 am |
| T24gNC8yMi8wNiwgR3JhaGFtIER1bXBsZXRvbiA8
Z3JhaGFtZEBkc2NwbC5jb20uYXU+IHdyb3Rl
Ogo+IFVuZm9ydHVuYXRlbHkgaXQgdGVuZHMgdG8g
YmUganVzdCB5b3UgYW5kIEkgdG9zc2luZyBp
ZGVhcyBiYWNrIGFuZCBmb3J0aAo+IGFuZCB3aGVu
IHlvdSBoYXZlIGEgdHdvIHBlcnNvbiBkZW1v
Y3JhY3kgYXQgd29yaywgaGFyZCB0byBnZXQgc29t
ZQo+IGNvbnNlbnN1cyBvZiB3aGF0IGlzIHRo
ZSBiZXN0IGRpcmVjdGlvbiB0byBnby4gOi0oCgpJ
IHRoaW5rIHRoZSBuYW1lc3BhY2UgZGlyZWN0
aW9uIHlvdSdyZSB0YWtpbmcgaXMgZ3JlYXQuICBK
dXN0IHRvIGJlIGNsZWFyLAp0aGUgZG90dGVk
LW5vdGF0aW9uIGlzIHNpbXBseSB0aGF0LCBhIG5v
dGF0aW9uLiBUaGUgaW50ZXJmYWNlIHRvCnJl
cS5nZXRfb3B0aW9ucygpCmlzIG5vdCBjaGFuZ2lu
ZyBpcyBpdD8KCkkgYWxzbyB0aGluayB0aGF0
IGEgbGlzdGluZyBvZiBhbGwgdGhlIHJlc2VydmVk
IG9yIG1vZF9weXRob24gb3B0aW9ucyBpbiB0
aGUKZG9jcyBmb3IgUHl0aG9uT3B0aW9uIGlzIGEg
dmVyeSBnb29kIGlkZWEuICBBbmQgaXQgc2hv
dWxkIGRlZmluaXRlbHkgYmUKbWVudGlvbmVkIHRo
YXQgdGhlIGVudGlyZSBtb2RfcHl0aG9uLiog
bmFtZXMgYXJlIHJlc2VydmVkLCBhbmQgdGhhdAph
cHBsaWNhdGlvbnMgb3IgZnJhbWV3b3JrcyBh
cmUgZW5jb3VyYWdlZCB0byBpbXBsZW1lbnQgdGhl
aXIgb3duCnByZWZpeC9uYW1lc3BhY2VzIGZv
ciB0aGVpciBvd24gb3B0aW9ucy4KLS0KRGVyb24g
TWVyYW5kYQo=
| |
| Jim Gallacher 2006-04-27, 6:52 am |
| 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
|
|
|
|
|