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

DM-46496: Include advanced query system objects in docs #1099

Merged
merged 2 commits into from
Oct 17, 2024

Conversation

dhirving
Copy link
Contributor

@dhirving dhirving commented Oct 16, 2024

Butler.query has been public for a while, but the documentation for the Query object it returns was not included in the documentation.

This change pulls in the user-facing portions of the interface without any of the internal objects. (The internal objects are sometimes referenced from constructors, but those constructors are documented as "do not use".)

Checklist

  • ran Jenkins
  • added a release note for user-visible changes to doc/changes
  • (if changing dimensions.yaml) make a copy of dimensions.yaml in configs/old_dimensions

Copy link

codecov bot commented Oct 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.74%. Comparing base (be031d3) to head (f27bf9f).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1099      +/-   ##
==========================================
- Coverage   89.74%   89.74%   -0.01%     
==========================================
  Files         361      361              
  Lines       47410    47409       -1     
  Branches     5724     5724              
==========================================
- Hits        42549    42548       -1     
  Misses       3508     3508              
  Partials     1353     1353              

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

`Butler.query` has been public for a while, but the documentation for the `Query` object it returns was not included in the documentation.

This change pulls in the user-facing portions of the interface without any of the internal objects.  (The internal objects are sometimes referenced from constructors, but those constructors are documented as "do not use".)
@dhirving dhirving merged commit bde5552 into main Oct 17, 2024
18 checks passed
@dhirving dhirving deleted the tickets/DM-46496 branch October 17, 2024 19:28
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.

2 participants