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

API cleanup #92

Closed
ethanwhite opened this issue Feb 16, 2024 · 2 comments · Fixed by #118
Closed

API cleanup #92

ethanwhite opened this issue Feb 16, 2024 · 2 comments · Fixed by #118
Assignees

Comments

@ethanwhite
Copy link
Collaborator

ethanwhite commented Feb 16, 2024

I have a couple of suggestions for cleaning up the API to make it more consistent. I'll demonstrate the suggested changes using the CLI, but I think we'd also want to make similar changes to the Python interface for consistency:

  • install python_libraries -> install python-packages
  • install minicran -> install r-packages
  • add-packages r package1 -> add-r-packages package1
  • add-packages python package1 -> add-python-packages package1

An alternative to the last two changes, if we thought we might want to do something similar for lessons, would be:

  • add-packages r package1 -> add r-packages package1
  • add-packages python package1 -> add python-packages package1

which would then allow:

  • add lessons url1 url2

Thoughts?

@garezana
Copy link
Collaborator

garezana commented Feb 16, 2024

This is definitely an improvement, particularly the change from "minicran" to "r-packages." After reading this, I realized that the user base may not be familiar with or utilize minicran. It is unnecessary to make users write this prompt explicitly.
In my opinion, using the format add python-packages package1 is more intuitive as it clearly separates the action of adding from the desired content.

@ethanwhite
Copy link
Collaborator Author

@garezana - you had indicated that you were working on this. If you are can you provide an ETA. If not I'm happy to take care of it.

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

Successfully merging a pull request may close this issue.

2 participants