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

Should package name be “polars”? #82

Closed
grantmcdermott opened this issue Mar 20, 2023 · 5 comments
Closed

Should package name be “polars”? #82

grantmcdermott opened this issue Mar 20, 2023 · 5 comments

Comments

@grantmcdermott
Copy link
Collaborator

grantmcdermott commented Mar 20, 2023

As a general principle, I think that repo names should correspond exactly to package names. Unfortunately, there’s a subtle hyphen in the way here, which IMO is unnecessary and potentially confusing for users who are trying to install from source.

TL;DR Consider moving the repo from pola-rs/r-polars to pola-rs/rpolars (i.e., drop the second hyphen).

@sorhawell
Copy link
Collaborator

@grantmcdermott you're right it is a bit confusing as of now.

Current naming within the polars organization are (project; package)
py-polars; polars
rust-polars; polars
nodejs-polars; ?
r-polars; rpolars

I don't like currently writing docs and have to choose between r-polars and rpolars knowing most readers will not see the difference.
I was concidering to also rename the R package just polars. This would also be more alligned with the r-arrow;arrow naming standard.

What do you think of that?

@eitsupi
Copy link
Collaborator

eitsupi commented Mar 20, 2023

Perhaps one of the following two would be better?

  • repo: pola-rs/r-polars, package: polars
  • repo: pola-rs/rpolars, package: rpolars

Certainly the former may be more consistent. (which seems to be more common in the R package)

@grantmcdermott
Copy link
Collaborator Author

grantmcdermott commented Mar 20, 2023

Thanks both. I really like @eitsupi's first suggestion: Use repo: pola-rs/r-polars, package: polars.

This would obviously be a breaking change, since the package name will be changing. But I personally think it's worth it to establish long-term consistency. (And, as @sorhawell says, make it easier to maintain docs!)

P.S. I'm sure there are plenty of examples that follow the above structure. But one that comes to mind is tinytest.

@grantmcdermott grantmcdermott changed the title Should repo name be “rpolars”? Should package name be “polars”? Apr 5, 2023
@vincentarelbundock
Copy link
Collaborator

I think this can be closed via the recent PR merge, no?

@eitsupi
Copy link
Collaborator

eitsupi commented Apr 15, 2023

Yes, let's close.

@eitsupi eitsupi closed this as completed Apr 15, 2023
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

4 participants