Thread: Re: [Epydoc-devel] Epydoc URLs and external API linking
Brought to you by:
edloper
From: Daniele V. <pi...@de...> - 2007-02-19 16:52:04
|
> On Feb 18, 2007, at 7:04 PM, Daniele Varrazzo wrote: >> Edward, would you like to keep the current URL fragments with their >> small >> shortcomings or do you prefer to mangle fragments? I prefer to >> decide it >> before releasing the beta package, which is about ready. >> >> A simple naming scheme could be: >> >> - prefix each uppercase and underscore with an underscore >> - prefix each name with a letter (let's say N, for "name") > > Would this be done just for anchors, or for filenames as well? I > guess this depends on whether we are assuming that files are written > to a case-insensitive filesystem. I think what most frequently happens is a class with the same name of a module (case sensitive or not) and they are already distinct files. Sincerely i haven't though about a module containing two classes "myclass" and "MyClass", which may be an issue in a non case sensitive system. Conversely that guy won't have a package containing "MyModule" and "mymodule" because they require two files with the same name (on case-insensitive system). Such a case couldn't even be used on Windows. All the reasoning about object labelling was only about anchors, which currently happen to be invalid (or ambiguous). I don't think we have a compelling reason to change the file names. > I don't mind changing anchors too > much, but would rather not have the filenames become like N_My_Class- > class.html, if we can avoid it. I guess perhaps there could be a > command-line switch to control whether the name mangling applies to > just the anchors or to the entire URL -- perhaps something like "-- > case-insensitive-filesystem" to reflect its intended usage. I'd avoid letting the users decide it, and avoid adding a command switch to control the behaviour. I think Epydoc should generate the same names on system with different respect for file name case. -- Daniele Varrazzo - Develer S.r.l. http://www.develer.com |