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 example readme #1615

Merged
merged 4 commits into from
Apr 25, 2022
Merged

Add example readme #1615

merged 4 commits into from
Apr 25, 2022

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Apr 24, 2022

Which issue does this PR close?

Related to #1613

Having concise descriptions of examples will help people find them

What changes are included in this PR?

README.md file in arrow / examples directory

See rendered version: https://github.com/alamb/arrow-rs/tree/alamb/examples_doc/arrow/examples

Are there any user-facing changes?

moar docs!

@github-actions github-actions bot added the arrow Changes to the arrow crate label Apr 24, 2022
@alamb alamb mentioned this pull request Apr 24, 2022
6 tasks
@codecov-commenter
Copy link

Codecov Report

Merging #1615 (4d1ef62) into master (5374289) will decrease coverage by 0.00%.
The diff coverage is n/a.

❗ Current head 4d1ef62 differs from pull request most recent head 01caa0a. Consider uploading reports for the commit 01caa0a to get more accurate results

@@            Coverage Diff             @@
##           master    #1615      +/-   ##
==========================================
- Coverage   82.90%   82.89%   -0.01%     
==========================================
  Files         193      193              
  Lines       55464    55464              
==========================================
- Hits        45980    45978       -2     
- Misses       9484     9486       +2     
Impacted Files Coverage Δ
parquet_derive/src/parquet_field.rs 65.75% <0.00%> (-0.69%) ⬇️
parquet/src/encodings/encoding.rs 93.37% <0.00%> (-0.19%) ⬇️
arrow/src/array/transform/mod.rs 86.57% <0.00%> (+0.11%) ⬆️
arrow/src/datatypes/datatype.rs 66.80% <0.00%> (+0.39%) ⬆️

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 5374289...01caa0a. Read the comment docs.


# Examples

- [`builders](builders.rs): Using the Builder API
Copy link
Member

Choose a reason for hiding this comment

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

Missing right "`"

Copy link
Member

Choose a reason for hiding this comment

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

And, maybe builders.rs? To be consistent with others.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

in 6851adf

@alamb
Copy link
Contributor Author

alamb commented Apr 25, 2022

Thanks @viirya

@alamb alamb merged commit 6475426 into apache:master Apr 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
arrow Changes to the arrow crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants