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

improve manual entry of assignment to a data frame #3201

Merged
merged 4 commits into from
Oct 27, 2022
Merged

Conversation

bkamins
Copy link
Member

@bkamins bkamins commented Oct 16, 2022

Fixes #3200

@bkamins bkamins added this to the patch milestone Oct 16, 2022
@bkamins bkamins added the doc label Oct 16, 2022
@nalimilan
Copy link
Member

I'm not sure it's the place to mention this kind of thing. Getting Started is supposed to be a simple illustration of basics using examples. This is more like reference documentation which risks scaring newcomers.

@bkamins
Copy link
Member Author

bkamins commented Oct 17, 2022

Yes - I was also thinking about it. The problem is:

What should we write to avoid users thinking that df[!, :col] is non copying also in broadcasted assignment. Users repeatedly report that they read in Getting Started about it and I every time need to explain that getindex is not the same as broadcast! or setindex!.

I think we should write something. The question is what then?

@nalimilan
Copy link
Member

Maybe add a short explanation/example in the section right before "Constructing Column by Column"? Mentioning all rules would be too complex but maybe a few words are enough to explain the essentials?

@bkamins
Copy link
Member Author

bkamins commented Oct 22, 2022

OK - I have changed it to use examples.

I have also reviewed basics.md. Interestingly it was more precise and mostly good because it is fresher (I just needed to change two sentences - I marked them with a comment). The rest of changes is improving line breaks as the source did not look good to me.

docs/src/man/basics.md Show resolved Hide resolved
docs/src/man/getting_started.md Outdated Show resolved Hide resolved
docs/src/man/getting_started.md Outdated Show resolved Hide resolved
docs/src/man/getting_started.md Outdated Show resolved Hide resolved
@bkamins bkamins merged commit abbed11 into main Oct 27, 2022
@bkamins bkamins deleted the bkamins-patch-1 branch October 27, 2022 08:26
@bkamins
Copy link
Member Author

bkamins commented Oct 27, 2022

Thank you. Once the CI passes on main I will tag a new release.

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.

Why isn't df.col .= v in-place?
2 participants