Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename DDF.py script to ddfacet #5

Open
gijzelaerr opened this issue Dec 27, 2017 · 5 comments
Open

rename DDF.py script to ddfacet #5

gijzelaerr opened this issue Dec 27, 2017 · 5 comments

Comments

@gijzelaerr
Copy link

see discussion on slack.

@mhardcastle
Copy link
Collaborator

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
Copy link
Author

gijzelaerr commented Dec 28, 2017

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
Copy link
Collaborator

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
Copy link
Contributor

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
Copy link
Contributor

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

bennahugo pushed a commit to bennahugo/DDFacet-1 that referenced this issue Apr 6, 2018
move from pyfits to astropy.io.fits
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants