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 frictionless documentation #579

Merged
merged 6 commits into from
Jul 25, 2021
Merged

Add frictionless documentation #579

merged 6 commits into from
Jul 25, 2021

Conversation

TColl
Copy link
Contributor

@TColl TColl commented Jul 24, 2021

Fixes #492

I wrote the original code, so I guess it makes sense for me to have a stab at this one!

I've expanded the docstrings within pandera.io and then included a minimal new page within the documentation to render these more clearly - this feels like a more sensible option than writing documentation from scratch, given that we're only partially covering the frictionless feature set and this might change in future, so any changes will just need to be reflected in the accompanying docstrings to get pulled through to the documentation in future builds

@codecov
Copy link

codecov bot commented Jul 24, 2021

Codecov Report

Merging #579 (697fce2) into master (36e0ea3) will decrease coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #579      +/-   ##
==========================================
- Coverage   98.55%   98.52%   -0.03%     
==========================================
  Files          26       26              
  Lines        3255     3258       +3     
==========================================
+ Hits         3208     3210       +2     
- Misses         47       48       +1     
Impacted Files Coverage Δ
pandera/io.py 100.00% <ø> (ø)
pandera/typing.py 97.05% <0.00%> (-1.41%) ⬇️

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 36e0ea3...697fce2. Read the comment docs.

@cosmicBboy
Copy link
Collaborator

thanks @TColl! Will handle the failing tests

@cosmicBboy cosmicBboy merged commit 5a1e30e into unionai-oss:master Jul 25, 2021
@TColl TColl deleted the frictionless-docs branch July 25, 2021 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for importing frictionless schemas
2 participants