fix: correct getindex(vi, ::Colon) docstring (#854)#1382
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1382 +/- ##
=======================================
Coverage 78.56% 78.56%
=======================================
Files 50 50
Lines 3522 3522
=======================================
Hits 2767 2767
Misses 755 755 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Hlw @yebai I've been contributing to DynamicPPL.jl and really enjoying it. With @penelopeysm moving on could you point me to someone who could review PRs going forward? I'd love to keep contributing. Note: This PR addresses the docstring fix as mentioned in the issue. The larger fix of changing the behaviour of vi[:] to return untransformed values is a separate more involved task that is left for a future PR. |
9d70887 to
164ae02
Compare
|
The Group2 test failures were already present on main (see CI run #4478 on commit e2d4b5d) and are not caused by this change. |
Closes #854
What was the problem?
The docstring for
getindex(vi::AbstractVarInfo, ::Colon)incorrectlystated that it returns values "in the support of its distribution(s)".
This is wrong -
vi[:]actually returns the internally stored values,which may be in transformed (linked) space if
vihas been linked.What did I fix?
Updated the docstring to correctly state that:
vi[:]returns internal values which may be transformedgetindex_internalafter callinginvlink