search

saopicc / DDFacet

DDFacet Imaging Project
GNU General Public License v2.0
14 stars 13 forks source link

rename DDF.py script to ddfacet #5

Open gijzelaerr opened 6 years ago

gijzelaerr commented 6 years ago

see discussion on slack.

mhardcastle commented 6 years ago

Please explain for those of us who don't know how to see the discussion on slack?

This would break any code that calls DDF.py...

gijzelaerr commented 6 years ago

my comment: just a generic style guide note, if you bundle your software with a script that should be called from PATH, please don't add a .py extension and do make it all lower case. Don't forget to add the shebang (#!/usr/bin/env python2). There is no added value to having that .py extention or have Upper case or CamelCase scripts. Think about it. I don't know any popular UNIX program that violates this policy. DDF.py makes my eyes bleed.

@o-smirnov: Agreed, let's make it ddfacet.

mhardcastle commented 6 years ago

If this is to be done -- and it's not my decision -- then someone should at least write a wrapper script DDF.py that prints out a deprecation warning and then calls ddfacet proper. Breaking the user interface in order to comply with one person's style choices is not sensible, whatever your views about whether they're right or not.

o-smirnov commented 6 years ago

one person's style choices

To be fair, it's not as whimsical as all that. When maintaining a repository with dozens of packages, as @gijzelaerr is doing, consistent naming conventions avoid confusion and ultimately save time. There's a reason all Debian packages follow this policy.

But we can easily maintain backwards compatibility with a wrapper script or alias -- no sense in punishing the early adopters. :)

o-smirnov commented 6 years ago

P.S. Same thing applies to naming conventions in the code. But I'm not even thinking of going there....