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

Add hints to use macro packages for new users #3238

Merged
merged 3 commits into from
Dec 24, 2022
Merged

Add hints to use macro packages for new users #3238

merged 3 commits into from
Dec 24, 2022

Conversation

bkamins
Copy link
Member

@bkamins bkamins commented Dec 5, 2022

Users asked to give a hint that macro-packages can be easier to use for newcomers in the opening page of DataFrames.jl manual near its top (so that it is easily discoverable).

@nalimilan, @pdeffebach, @jkrumbiegel - I have proposed something, but I am not sure if the wording is best. Can you please comment? (I think that good wording here is important) Thank you!

Also I mention only DataFramesMeta.jl as I did not want to introduce additional user confusion (i.e. that they need to make choices between DataFramesMeta.jl and DataFrameMacros.jl). But maybe it is better to mention both. I am open for suggestions.
(they are both mentioned below in data wrangling section)

@bkamins bkamins added the doc label Dec 5, 2022
@bkamins bkamins added this to the patch milestone Dec 5, 2022
@pdeffebach
Copy link
Contributor

I think this looks good, thanks!

@jkrumbiegel
Copy link
Contributor

One the one hand I'm ok with the text as it is, on the other you might add something like "or one of the other convenience packages" or so and just intra-link to the section where they are shown. Often people just stick with what they encounter first, so I personally like laying out the options early. Unless you want to endorse DataFramesMeta as the macro-arm of DataFrames, which you can of course do and might be a good decision, too, from an ecosystem building perspective. I'm happy if people find something that works for them in the Julia ecosystem, my only worry regarding DataFrameMacros was always that it would mostly be disregarded because it seems not to be the "official" package (without understanding anything about the differences), not because it's not good.

@bkamins
Copy link
Member Author

bkamins commented Dec 8, 2022

Unless you want to endorse DataFramesMeta

I do not want to endorse a single package. I will add a sentence you propose with the link to the section.

@jkrumbiegel
Copy link
Contributor

Sounds good, thank you!

docs/src/index.md Outdated Show resolved Hide resolved
Co-authored-by: Milan Bouchet-Valat <nalimilan@club.fr>
@bkamins bkamins merged commit 71bfa6c into main Dec 24, 2022
@bkamins bkamins deleted the bkamins-patch-1 branch December 24, 2022 11:54
@bkamins
Copy link
Member Author

bkamins commented Dec 24, 2022

Thank you!

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

Successfully merging this pull request may close these issues.

4 participants