Skip to content

DOC: Ambiguous description in to_parquet engine documentation #19669

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 20 commits into from
Feb 15, 2018
Merged

DOC: Ambiguous description in to_parquet engine documentation #19669

merged 20 commits into from
Feb 15, 2018

Conversation

giba0
Copy link
Contributor

@giba0 giba0 commented Feb 12, 2018 •
edited
Loading

Ambiguity correction in documentation on pandas.DataFrame.to_parquet

giba0 added 14 commits February 12, 2018 00:02
@giba0
documentação
bf59983
@giba0
Revert "documentação"
2a49a9a 
This reverts commit bf59983.
@giba0
Merge branch 'master' into upstream/master
a6a5e96
@giba0
Merge remote-tracking branch 'origin/master'
f235163
@giba0
Merge branch 'master' into upstream/master
55b2661
@giba0
Creating the window folder and the files test_rolling.py, test_expand…
1785d61 
…ing.py, and

test_ewma.py
@giba0
Inclusion of tests for the rolling functions according to the file te…
b9c121d 
…st_window.py
@giba0
Inclusion of tests for the expanding functions according to the test_…
018685b 
…window.py file
@giba0
Inclusion of tests for the ewma functions according to the test_windo…
3cef534 
…w.py file
@giba0
Correcting file formatting.
9cb7a4f
@giba0
Merge branch 'master' of https://github.com/pandas-dev/pandas
9a4469e
@giba0
Merge branch 'master' into TST--split-tests-for-windows-to-sub-modules-…
52db43a 
…pandas-dev#19228
@giba0
Merge branch 'TST--split-tests-for-windows-to-sub-modules-pandas-dev#…
375c68d 
…19228'
@giba0
Ambiguity correction in documentation on pandas.DataFrame.to_parquet
8414a1f
@giba0 giba0 closed this Feb 13, 2018
@giba0 giba0 reopened this Feb 13, 2018
@codecov
Copy link

codecov bot commented Feb 13, 2018 •
edited
Loading

Codecov Report

Merging #19669 into master will increase coverage by 0.03%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #19669      +/-   ##
==========================================
+ Coverage   91.57%    91.6%   +0.03%     
==========================================
  Files         150      150              
  Lines       48817    48864      +47     
==========================================
+ Hits        44704    44764      +60     
+ Misses       4113     4100      -13
Flag Coverage Δ
#multiple 89.98% <ø> (+0.03%) ⬆️
#single 41.75% <ø> (+0.02%) ⬆️
Impacted Files Coverage Δ
pandas/io/parquet.py 71.79% <ø> (ø) ⬆️
pandas/core/frame.py 97.16% <ø> (ø) ⬆️
pandas/core/arrays/base.py 60% <0%> (-0.61%) ⬇️
pandas/core/indexes/multi.py 95.06% <0%> (-0.01%) ⬇️
pandas/core/dtypes/concat.py 99.14% <0%> (ø) ⬆️
pandas/core/arrays/categorical.py 94.89% <0%> (+0.01%) ⬆️
pandas/core/base.py 96.79% <0%> (+0.01%) ⬆️
pandas/core/indexes/category.py 97.27% <0%> (+0.01%) ⬆️
pandas/core/indexes/base.py 96.46% <0%> (+0.02%) ⬆️
pandas/core/indexes/interval.py 92.44% <0%> (+0.04%) ⬆️
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d9551c8...8fac45b. Read the comment docs.

@TomAugspurger
Copy link
Contributor

Looks like some stray commits got into your PR. Do you need help cleaning up your branch?

@TomAugspurger TomAugspurger added Docs IO Parquet parquet, feather labels Feb 13, 2018
@giba0
Copy link
Contributor Author

giba0 commented Feb 13, 2018 •
edited
Loading

@TomAugspurger yes I need! I tried in several ways to clear the jump but I could not! can you help me?

@TomAugspurger
Merge remote-tracking branch 'upstream/master' into gilbertoolimpio-D…
6460364 
…OCS---Ambiguous-description-in-pandas.DataFrame.to_parquet-documentation-pandas-dev#19662
@TomAugspurger
remove window
112bb1f
@TomAugspurger
Copy link
Contributor

TomAugspurger commented Feb 13, 2018 •
edited
Loading

Ok, should be good now. I added a commit deleting your window-related changes.

In general, when you make a PR you want to

# fetch the latest changes from master
git fetch upstream

git checkout master
git pull

# Checkout a new branch for your changes
git checkout -b parquet-docs

And you do that for each PR independently.

@giba0
Copy link
Contributor Author

giba0 commented Feb 13, 2018 •
edited
Loading

@TomAugspurger thanks for helping this newbie!

jorisvandenbossche
jorisvandenbossche reviewed Feb 13, 2018
View reviewed changes
pandas/core/frame.py Outdated
'io.parquet.engine' is used. If 'auto', then the first
library to be installed is used.
Parquet library to use. If 'auto', the value from
``io.parquet.engine`` is used. The default ``io.parquet.engine``
Copy link
Member

Choose a reason for hiding this comment

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

I would clarify "io.parquet.engine", as now it seems like a constant in pandas.io.parquet.engine, which is not the case, it is an option. Maybe leaving "the option io.parquet.engine .." as before is enough

@giba0
Copy link
Contributor Author

giba0 commented Feb 13, 2018

@jorisvandenbossche I did the suggested fix, could you check it now?

@jorisvandenbossche
Copy link
Member

@gilbertoolimpio It seems you reverted the full explanation? My comment was only to keep the word "option", the rest of the modifications were certainly an improvement!

@giba0
Copy link
Contributor Author

giba0 commented Feb 13, 2018

@jorisvandenbossche Ops! now was better? =)

@jorisvandenbossche
Copy link
Member

Yes, that's better. Can you do the same for the other occurrences?

@giba0
Copy link
Contributor Author

giba0 commented Feb 13, 2018

@jorisvandenbossche newbie here! =) Thanks for your help! Now all updated.

jorisvandenbossche
jorisvandenbossche approved these changes Feb 13, 2018
View reviewed changes
Copy link
Member

@jorisvandenbossche jorisvandenbossche left a comment

Choose a reason for hiding this comment

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

Yes, looking good now!

@jorisvandenbossche jorisvandenbossche added this to the 0.23.0 milestone Feb 13, 2018
@jorisvandenbossche jorisvandenbossche changed the title DOC - Ambiguous description in pandas.data frame.to parquet documentation DOC: Ambiguous description in to_parquet engine documentation Feb 15, 2018
@jorisvandenbossche jorisvandenbossche merged commit db55f47 into pandas-dev:master Feb 15, 2018
harisbal pushed a commit to harisbal/pandas that referenced this pull request Feb 28, 2018
@giba0
DOC: Ambiguous description in to_parquet engine documentation (pandas…
e7a26b0 
…-dev#19669)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jorisvandenbossche jorisvandenbossche jorisvandenbossche approved these changes

Assignees
No one assigned
Labels
Docs IO Parquet parquet, feather
Projects
None yet
Milestone
0.23.0
Development

Successfully merging this pull request may close these issues.

Ambiguous description in pandas.DataFrame.to_parquet documentation
3 participants
@giba0 @TomAugspurger @jorisvandenbossche