Skip to content

More consistent naming #58

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

Merged
merged 1 commit into from
Jun 24, 2022

Conversation

martinRenou
Copy link
Member

Fix #57

cc. @jasongrout

@martinRenou martinRenou added the enhancement New feature or request label Jun 23, 2022
@martinRenou martinRenou changed the title More consisten naming More consistent naming Jun 23, 2022
@jasongrout
Copy link
Collaborator

+1, especially while we're still pretty small and growing.

Just double checking - is it consistently jupyter_lite (i.e., two words) over in JupyterLite for all the various user APIs, not just for jupyter_lite_conf

@jasongrout
Copy link
Collaborator

jasongrout commented Jun 23, 2022

I don't have permission to merge, but I can approve. Thanks!

@martinRenou
Copy link
Member Author

You should have received an invitation to the jupyterlite org and for having commit rights on this repo :) You probably need to accept it. I let you merge then! :)

@jasongrout
Copy link
Collaborator

On second thought, I looked through the jupyterlite repo, and they are more consistently treating jupyterlite as one word in the code, even if the config file naming is treating jupyterlite as two words. I think we ought to hold off on the breaking change here to get more clarity on which way we should consistently name things. It may be that they decide to change jupyterlite to have the config file be named jupyterlite_config.json?

@jtpio
Copy link
Member

jtpio commented Jun 23, 2022

Probably this is unlikely to change in jupyterlite, and I believe jupyter_lite_config.json was chosen since it's similar to jupyter_notebook_config.json or jupyter_server_config.json.

@jasongrout
Copy link
Collaborator

Probably this is unlikely to change in jupyterlite, and I believe jupyter_lite_config.json was chosen since it's similar to jupyter_notebook_config.json or jupyter_server_config.json.

Thanks for chiming in, and for some of the context.

@martinRenou martinRenou merged commit 93fb60e into jupyterlite:main Jun 24, 2022
@martinRenou martinRenou deleted the consistent_naming branch June 24, 2022 09:36
@jasongrout
Copy link
Collaborator

After thinking about this more and sleeping on it, I was thinking that maybe it makes sense to have the filename be jupyter_lite_config.json, but the sphinx option names be jupyterlite_config, jupyterlite_dir, etc. In other words, I think the only exception to thinking of jupyterlite as one word is the filename, to be consistent with other Jupyter things. This would be consistent with the naming jupyterlite_sphinx, for example.

@martinRenou
Copy link
Member Author

Arf sorry I merged so fast then :S

I agree with you, let's revert and release again.

@jasongrout
Copy link
Collaborator

I agree with you, let's revert and release again.

+1 - I think this would be 0.6.0, since this is technically breaking the 0.5.0 api. I don't think we need to put in backwards compatible shims, though, on the thought that most people would not have upgraded to 0.5.0.

jasongrout added a commit to jasongrout/jupyterlite-sphinx that referenced this pull request Aug 17, 2022
In jupyterlite#62, we reverted the config name changes from jupyterlite#58. However, we forgot to revert the changes to our docs conf.py config as well.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Default config file option is inconsistent with jupyterlite
3 participants