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

Clean up lightly.api docs #1385

Merged
merged 1 commit into from
Sep 11, 2023

Conversation

michal-lightly
Copy link
Contributor

@michal-lightly michal-lightly commented Sep 11, 2023

What has changed and why?

Removed deprecated and internal api functions from the generated docs.

Closes #1375.

How has it been tested?

  • Locally built the docs. Checked that entries are missing.
  • Checksum: There are 24 entries to remove and 24x added a line with :meta private:

@codecov
Copy link

codecov bot commented Sep 11, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (afced0a) 85.41% compared to head (9f1e788) 85.41%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1385   +/-   ##
=======================================
  Coverage   85.41%   85.41%           
=======================================
  Files         130      130           
  Lines        5465     5465           
=======================================
  Hits         4668     4668           
  Misses        797      797           
Files Changed Coverage Δ
lightly/api/api_workflow_client.py 98.97% <ø> (ø)
lightly/api/api_workflow_compute_worker.py 96.25% <ø> (ø)
lightly/api/api_workflow_datasources.py 93.54% <ø> (ø)
lightly/api/api_workflow_predictions.py 100.00% <ø> (ø)
lightly/api/api_workflow_selection.py 83.63% <ø> (ø)
lightly/api/api_workflow_tags.py 96.29% <ø> (ø)
lightly/api/api_workflow_upload_embeddings.py 88.42% <ø> (ø)
lightly/api/api_workflow_upload_metadata.py 90.56% <ø> (ø)
lightly/utils/io.py 91.22% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@michal-lightly michal-lightly marked this pull request as ready for review September 11, 2023 15:51
@michal-lightly michal-lightly merged commit 3f3714d into master Sep 11, 2023
10 checks passed
@michal-lightly michal-lightly deleted the michal-lig-3907-clean-up-lightlyapi-docs branch September 11, 2023 16:18
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.

Clean up lightly.api docs
2 participants