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.

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

[DL-702] API reference updates #1883

Merged
merged 15 commits into from
Sep 19, 2022
Merged

[DL-702] API reference updates #1883

merged 15 commits into from
Sep 19, 2022

Conversation

FayazRahman
Copy link
Contributor

@FayazRahman FayazRahman commented Sep 16, 2022 •
edited
Loading

🚀 🚀 Pull Request

Checklist:

  • My code follows the style guidelines of this project and the Contributing document
  • I have commented my code, particularly in hard-to-understand areas
  • I have kept the coverage-rate up
  • I have performed a self-review of my own code and resolved any problems
  • I have checked to ensure there aren't any other open Pull Requests for the same change
  • I have described and made corresponding changes to the relevant documentation
  • New and existing unit tests pass locally with my changes

Changes

  • API reference updates - meta, info, linked samples
  • Added copy button for code blocks

@codecov
Copy link

codecov bot commented Sep 16, 2022 •
edited
Loading

Codecov Report

Base: 92.59% // Head: 92.57% // Decreases project coverage by -0.02% ⚠️

Coverage data is based on head (24b958e) compared to base (37de031).
Patch has no changes to coverable lines.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1883      +/-   ##
==========================================
- Coverage   92.59%   92.57%   -0.03%     
==========================================
  Files         245      245              
  Lines       26009    26009              
==========================================
- Hits        24084    24078       -6     
- Misses       1925     1931       +6
Flag Coverage Δ
unittests 92.57% <ø> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
hub/api/info.py 87.09% <ø> (ø)
hub/api/link.py 100.00% <ø> (ø)
hub/core/dataset/dataset.py 92.79% <ø> (+0.07%) ⬆️
hub/core/linked_sample.py 100.00% <ø> (ø)
hub/core/meta/dataset_meta.py 100.00% <ø> (ø)
hub/core/meta/meta.py 100.00% <ø> (ø)
hub/core/meta/tensor_meta.py 88.18% <ø> (ø)
hub/core/tensor.py 86.49% <ø> (ø)
hub/htype.py 100.00% <ø> (ø)
hub/core/lock.py 86.30% <0.00%> (-2.39%) ⬇️
... and 2 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

AbhinavTuli
AbhinavTuli reviewed Sep 19, 2022
View reviewed changes
Copy link
Contributor

@AbhinavTuli AbhinavTuli left a comment

Choose a reason for hiding this comment

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

I'm strongly against exposting dataset and tensor meta internals in docs. We don't want users to use any of this

@FayazRahman
Copy link
Contributor Author

@AbhinavTuli Will hide meta stuff

@FayazRahman FayazRahman merged commit d4f625f into main Sep 19, 2022
@FayazRahman FayazRahman deleted the fy_api_ref branch September 19, 2022 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adolkhan adolkhan adolkhan approved these changes

@farizrahman4u farizrahman4u farizrahman4u approved these changes

@levongh levongh Awaiting requested review from levongh

@AbhinavTuli AbhinavTuli Awaiting requested review from AbhinavTuli

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@FayazRahman @farizrahman4u @AbhinavTuli @adolkhan