Updating docstrings for better code quality #4119
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Summary: ### Added Filtering by Trial Status to Summarize This diff adds a new feature to the `summarize` method, allowing users to filter by trial status. #### What's Changed Differential Revision: D79442982
Summary: This diff updates the docstrings in `client.py` and `summary.py` to improve code quality, making it easier for users to understand the purpose and usage of the functions. Specifically, the changes include: * Adding function argument explanations for `trial_indices` and `trial_status` in the `client.py` file. * Adding function argument explanations for `trial_indices`, `trial_status`, and `omit_empty_columns` in the `summary.py` file. These updates enhance the overall clarity and readability of the codebase, ensuring that users can effectively utilize the functions and their arguments. Reviewed By: mpolson64 Differential Revision: D79738530
meta-cla
bot
added
the
CLA Signed
Contributor
|
This pull request was exported from Phabricator. Differential Revision: D79738530 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4119 +/- ##
=======================================
Coverage 96.07% 96.07%
=======================================
Files 566 566
Lines 57044 57104 +60
=======================================
+ Hits 54806 54865 +59
- Misses 2238 2239 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
|
This pull request has been merged in 7df5b0e. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
This diff updates the docstrings in
client.pyandsummary.pyto improve code quality, making it easier for users to understand the purpose and usage of the functions. Specifically, the changes include:trial_indicesandtrial_statusin theclient.pyfile.trial_indices,trial_status, andomit_empty_columnsin thesummary.pyfile.These updates enhance the overall clarity and readability of the codebase, ensuring that users can effectively utilize the functions and their arguments.
Reviewed By: mpolson64
Differential Revision: D79738530