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

use prettier to format md files #367

Merged
merged 3 commits into from
May 24, 2021
Merged

Conversation

jimexist
Copy link
Member

@jimexist jimexist commented May 20, 2021

Which issue does this PR close?

Closes #.

Rationale for this change

What changes are included in this PR?

fd -e md md ballista docs -x prettier --write

Are there any user-facing changes?

@codecov-commenter
Copy link

Codecov Report

Merging #367 (a4d7a90) into master (2f73558) will not change coverage.
The diff coverage is n/a.

❗ Current head a4d7a90 differs from pull request most recent head 8e972b0. Consider uploading reports for the commit 8e972b0 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master     #367   +/-   ##
=======================================
  Coverage   75.88%   75.88%           
=======================================
  Files         143      143           
  Lines       23773    23773           
=======================================
  Hits        18041    18041           
  Misses       5732     5732           

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 2f73558...8e972b0. Read the comment docs.

Copy link
Contributor

@msathis msathis left a comment

Choose a reason for hiding this comment

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

Look good 👍 @jimexist should we also add a .prettierrc file if we used custom settings & lint task during build? Maybe a separate PR at a later time is fine as well.

Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

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

I reviewed the rendered changes manually by looking at
https://github.com/Jimexist/arrow-datafusion/tree/update-docs-format

And they look good -- thanks @jimexist

-V, --version Prints version information

OPTIONS:
-c, --batch-size <batch-size> The batch size of each query, default value is 1048576
-c, --batch-size <batch-size> The batch size of each query, or use DataFusion default
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

@jimexist
Copy link
Member Author

I reviewed the rendered changes manually by looking at

https://github.com/Jimexist/arrow-datafusion/tree/update-docs-format

And they look good -- thanks @jimexist

Thanks I've been thinking of adding a non failing CI job so that future changes can be detected

@jimexist
Copy link
Member Author

Look good 👍 @jimexist should we also add a .prettierrc file if we used custom settings & lint task during build? Maybe a separate PR at a later time is fine as well.

The philosophy of prettier is to apply as little config as possible so if not necessary I can leave out the rc file

@alamb alamb merged commit ee8b5bf into apache:master May 24, 2021
@jimexist jimexist deleted the update-docs-format branch May 24, 2021 14:31
@houqp houqp added ballista datafusion Changes in the datafusion crate documentation Improvements or additions to documentation labels Jul 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
datafusion Changes in the datafusion crate documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants