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 package to sphinx_gallery rather than sphinxgallery? #47

Closed
lesteve opened this issue Jul 31, 2015 · 12 comments
Closed

Rename package to sphinx_gallery rather than sphinxgallery? #47

lesteve opened this issue Jul 31, 2015 · 12 comments

Comments

@lesteve
Copy link
Member

lesteve commented Jul 31, 2015

A very minor annoyance, but I thought I would vent it out and ask for opinions, it seems to me that sphinx_gallery for the package name is more in line with sphinx-gallery as the project name.

Basically if people agree it would be wise to fix that sooner rather than later, to reduce the impact on potential users.

@agramfort
Copy link
Contributor

agramfort commented Jul 31, 2015 via email

@Titan-C
Copy link
Member

Titan-C commented Jul 31, 2015

I don't remember when we discussed this, but the package was already named sphinx_gallery and we changed for the one without the underscore. I don't have the reason in mind anymore.

@lesteve
Copy link
Member Author

lesteve commented Jul 31, 2015

I don't remember when we discussed this, but the package was already named sphinx_gallery and we changed for the one without the underscore. I don't have the reason in mind anymore.

You are right actually, interesting that was not what I remembered at all ... That was done in the first PR: #1 but there is no reason given in the PR or the commit message.

@lesteve
Copy link
Member Author

lesteve commented Jul 31, 2015

Anyway let's ask @GaelVaroquaux if he has any opinion about this.

If I am the only one to be slightly annoyed by this, I am more than happy to close the issue.

@GaelVaroquaux
Copy link
Contributor

GaelVaroquaux commented Jul 31, 2015 via email

@lesteve
Copy link
Member Author

lesteve commented Jul 31, 2015

I am actually slighlty annoyed too.

OK glad to know I am not completely on my own. Let's try to merge the mayavi PR first and then see whether there is enough annoyance between all of us to make the change.

@lesteve
Copy link
Member Author

lesteve commented Oct 27, 2015

Just remembered about this one. I think we should do it before the next release and I am even volunteering to do it.

Anyone strongly disagrees?

@GaelVaroquaux
Copy link
Contributor

Just remembered about this one. I think we should do it before the next
release and I am even volunteering to do it.

Anyone strongly disagrees?

No

@Titan-C
Copy link
Member

Titan-C commented Oct 27, 2015

For the module name it kind of feels simpler not to have underscores. Its an extra hard to reach key in the keyboard. Neverteless the aren't many calls to the module itself, only 2 in the conf.py file and that's all.
Now for consistency, you might want to also update the name of the configuration dictionary to sphinx_gallery_conf

@lesteve
Copy link
Member Author

lesteve commented Oct 27, 2015

Its an extra hard to reach key in the keyboard.

Even on a Dvorak keyboard? If that's the case we just need a Dvorak keyboard designed especially for Python.

I opened a PR, comments welcome.

@Titan-C
Copy link
Member

Titan-C commented Oct 27, 2015

Even on a Dvorak keyboard? If that's the case we just need a Dvorak keyboard designed especially for Python.

no on Dvorak the underscore is just by the right pinky finger, close to no effort

@lesteve
Copy link
Member Author

lesteve commented Oct 27, 2015

no on Dvorak the underscore is just by the right pinky finger, close to no effort

Great to know that all is well is the Dvorak world ;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants