(Fixes OSS CI) Have Sphinx track deprecated_transform_mixin, but make it private
#2330
Conversation
This file contains 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
…ke it private Summary: The OSS CI is failing: https://github.com/facebook/Ax/actions/runs/8581833037/job/23519269134?pr=2329 This should fix the Sphinx error. Adding `:meta private:` to the docstring will stop it from rendering, since OSS users shouldn't need to know about `DeprecatedTransformMixin` and can read the code on GH if they need to. Differential Revision: D55837917
facebook-github-bot
added
the
CLA Signed
|
This pull request was exported from Phabricator. Differential Revision: D55837917 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2330 +/- ##
=======================================
Coverage 94.91% 94.91%
=======================================
Files 491 491
Lines 47782 47782
=======================================
Hits 45350 45350
Misses 2432 2432 ☔ View full report in Codecov by Sentry. |
|
This pull request has been merged in adcf3a4. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
The OSS CI is failing: https://github.com/facebook/Ax/actions/runs/8581833037/job/23519269134?pr=2329
This should fix the Sphinx error. Adding
:meta private:to the docstring will stop it from rendering, since OSS users shouldn't need to know aboutDeprecatedTransformMixinand can read the code on GH if they need to.Differential Revision: D55837917