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

minimal changes to rename package #84

Merged
merged 18 commits into from
Apr 13, 2023
Merged

minimal changes to rename package #84

merged 18 commits into from
Apr 13, 2023

Conversation

sorhawell
Copy link
Collaborator

commit all, a few tests fail in check only, not sure why

@sorhawell
Copy link
Collaborator Author

A first attempt on renaming to polars #82

@eitsupi
Copy link
Collaborator

eitsupi commented Mar 21, 2023

minimal changes to rename repo

Maybe "rename package"?

@sorhawell sorhawell changed the title minimal changes to rename repo minimal changes to rename package Mar 21, 2023
@sorhawell
Copy link
Collaborator Author

Oups :)

@grantmcdermott
Copy link
Collaborator

grantmcdermott commented Mar 22, 2023

You've probably already noticed, but the vignette/rpolars.Rmd file will need to be changed to vignette/polars.Rmd, and then the internal refs in the same file to "(r)polars" will need to need to be changed too.

@sorhawell
Copy link
Collaborator Author

Small news update for all the kind contributors who read PRs :)
The next three months I have a consultancy contract and a little paternity leave. I will be working in some evenings, but things will progress slower and you might see some dangling draft PRs from my side, as this one.
However, I will try to process any Issue/request/PR within 48hours or so

@grantmcdermott
Copy link
Collaborator

Congrats! (I'm going on vacation tomorrow, so might not make the cutoff. But will see if I have anything that might get in under the wire...)

@sorhawell
Copy link
Collaborator Author

sorhawell commented Mar 30, 2023

I notice r-universe-org/help#28 might result in duplicate packages (rpolars + polars) for some time on R-universe. But I guess we can take it as it comes.

@sorhawell sorhawell marked this pull request as ready for review March 30, 2023 20:08
Copy link
Collaborator

@grantmcdermott grantmcdermott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of thoughts and suggestions, mostly regarding documentation.

Comment on lines 2 to 5
title: "Introduction to polars in R"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{Introduction to rpolars}
%\VignetteIndexEntry{Introduction to polars in R}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammatically, "polars in R" sounds a bit off. Maybe change to "An Introduction to Polars from R" (or just "Polars from R").

@@ -13,7 +13,7 @@ knitr::opts_chunk$set(
)
```

# rpolars
# polars
Copy link
Collaborator

@grantmcdermott grantmcdermott Mar 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this should be "Polars from R"? Although, if we're keeping with the arrow way of doing things then just "polars" is fine (see here)

@@ -26,7 +26,7 @@ The goal of this project is to bring the blazingly fast
computation engine is written in Rust and this R implementation has no other
dependencies than R itself (≥ 4.1.0).

Documentation can be found on the **rpolars**
Documentation can be found on the **r-polars**
Copy link
Collaborator

@grantmcdermott grantmcdermott Mar 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps personal preference but I think the link link should be to the actual index page (i.e., https://rpolars.github.io/index.html) rather than the reference manual. That way your readers are able top navigate more easily to where they want (e.g., installation section of the README/landing page or the vignette).

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will change back to entry page. It is also much prettier now, after latest release, as the main page is now your readme contribution :)

https://rpolars.github.io/

development workflow is as follows:

**Step 1:** Fork the **rpolars** repo on GitHub and then clone it locally.
**Step 1:** Fork the **polars** repo on GitHub and then clone it locally.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, to avoid ambiguity, I would say: "..Fork the R **polars repo..."

Also: This is more to do with Step 2+ (not shown here) but is this workflow still the same even if the repo structure has changed? Aren't we using the pola-rs/rpolars/package suggested by @eitsupi? (Or did I miss something?) If so, wouldn't they at least need to cd one directory deeper, i.e. cd r-polars/package...

@@ -195,10 +195,10 @@ Rust toolchain

#### Development workflow

Assuming the system dependencies have been met (above), the typical **rpolars**
Assuming the system dependencies have been met (above), the typical **polars**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To avoid ambiguity, I would say: "..the typical R polars workflow..."

**rpolars** package provides equivalent bindings from R.
libraries available in any language. The underlying computation engine is
written in Rust and can be used directly from via the polars crate. Orginally Polars bindings were implemented for Python. The **polars** R-package also provides equivalent bindings from R. Within
R, python and rust each polars package is just called polars. The implemention polars in the
Copy link
Collaborator

@grantmcdermott grantmcdermott Mar 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of typos here. I would rewrite, starting with the "Within" on the previous line:

"Note that, within each language, the relevant implementation package is just called "polars". However, for clarity we may use a prefix when referring to specific implementations (i.e., rust-polars, py-polars, r-polars, nodejs-polars, etc.)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Many thanks :) I add changes and Monday.

@grantmcdermott
Copy link
Collaborator

@sorhawell Your call at the end of the day, of course. But I think it's probably a good idea to merge this change sooner rather than later. (Assuming you're still happy with the renaming idea and all checks etc are passing.)

I noticed that the rpolars website and repo are being shared on social media, which seems to be triggering increased traffic and contributions. (Which is great!) I personally think it's better to align the structure of the repo now, before this branch diverges too much from any new contributions.

Tagging @eitsupi and @vincentarelbundock in case they have a different opinion.

@vincentarelbundock
Copy link
Collaborator

Thanks for the tag. I don't really have a view on this.

@eitsupi
Copy link
Collaborator

eitsupi commented Apr 12, 2023

I too think this should be merged.

From extendr's Discord conversation, @sorhawell seems to be busy these days.
@sorhawell If you would like, I can press the merge button on this PR. How about it?

This is a breaking change and should be noted in NEWS, etc., but I don't think it needs to be included in this PR since that can be done later.

@eitsupi
Copy link
Collaborator

eitsupi commented Apr 13, 2023

Ok, let's merge.

@eitsupi eitsupi merged commit a4def14 into main Apr 13, 2023
@eitsupi eitsupi deleted the rename_minimal branch April 13, 2023 13:43
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 this pull request may close these issues.

None yet

4 participants