DOC: add guidance on how to make a dataclass for result objects #18221
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
[skip azp] [skip actions] [skip cirrus]
tupui
added
scipy.stats
Documentation
melissawm
approved these changes
Mar 31, 2023
| @@ -87,6 +87,19 @@ private return classes, please see how `~scipy.stats.binomtest` summarizes | |||
| `~scipy.stats._result_classes.BinomTestResult` and links to its documentation, | |||
| and note that ``BinomTestResult`` cannot be imported from `~scipy.stats`. | |||
|
|
|||
| Depending on the complexity of "MyResultObject", a normal class or a dataclass | |||
| can be used. When using dataclasses, do not use ``dataclasses.make_dataclass``, | |||
There was a problem hiding this comment.
Just in case you want to add that reference:
Suggested change
| can be used. When using dataclasses, do not use ``dataclasses.make_dataclass``, | |
| can be used. When using dataclasses, do not use :py:func:`dataclasses.make_dataclass`, |
mdhaber
approved these changes
Apr 1, 2023
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.
As noted in #18216 we could describe how to create dataclasses when we create result objects.
cc @WillTirone