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 links in docstrings #605

Merged
merged 1 commit into from
Jul 29, 2021
Merged

Add links in docstrings #605

merged 1 commit into from
Jul 29, 2021

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Jul 25, 2021

Which issue does this PR close?

N/A

Rationale for this change

While reviewing the docs on https://docs.rs/arrow/5.0.0/arrow/array/trait.Array.html#implementors as part of #603 (thanks @novemberkilo !) I found a few structs that are not often used directly but that might not be clear from the docs

Are there any user-facing changes?

Add some doc links to the structs that users might be looking for

@alamb alamb added the documentation Improvements or additions to documentation label Jul 25, 2021
@github-actions github-actions bot added the arrow Changes to the arrow crate label Jul 25, 2021
@codecov-commenter
Copy link

Codecov Report

Merging #605 (ea4ad49) into master (6c1a86e) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #605   +/-   ##
=======================================
  Coverage   82.41%   82.41%           
=======================================
  Files         167      167           
  Lines       46240    46240           
=======================================
  Hits        38108    38108           
  Misses       8132     8132           
Impacted Files Coverage Δ
arrow/src/array/array_binary.rs 92.23% <ø> (ø)
arrow/src/array/array_list.rs 95.51% <ø> (ø)
arrow/src/array/array_string.rs 97.85% <ø> (ø)

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 6c1a86e...ea4ad49. Read the comment docs.

@alamb alamb requested a review from Dandandan July 26, 2021 22:33
@alamb alamb merged commit b46115b into apache:master Jul 29, 2021
alamb added a commit that referenced this pull request Jul 29, 2021
alamb added a commit that referenced this pull request Jul 29, 2021
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 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants