Fix numpydoc in pm.Data, pm.MutableData, pm.ConstantData #5485
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
Codecov Report
@@ Coverage Diff @@
## main #5485 +/- ##
=======================================
Coverage 81.44% 81.44%
=======================================
Files 81 81
Lines 14204 14204
=======================================
Hits 11569 11569
Misses 2635 2635
|
OriolAbril
requested changes
Feb 18, 2022
pymc/data.py
Outdated
| :func:`pymc.Model.set_data`. | ||
|
|
||
| For more information, take a look at this example notebook | ||
| https://docs.pymc.io/projects/examples/en/latest/pymc3_howto/data_container.html |
There was a problem hiding this comment.
We should not use html links to refer to pymc (or other python libraries commonly used like arviz, aesara, numpy...). This should be done with intersphinx:
:ref:`nb:data_container`
Which will show the title of the notebook as link text, so it's probably best to update the text something like "read the notebook"
Co-authored-by: Oriol Abril-Pla <[email protected]>
OriolAbril
approved these changes
Feb 18, 2022
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.
Addresses #5459.
This PR:
The
valueparameter still references pandas objects (pd.Series,pd.Dataframe).How should we handle them?
On the other hand, I think the reference notebook remains to be translated to the new version. I don't know if we should leave a comment to remember to change it once it is updated or not.
#DataUmbrellaPyMCSprint