fix: correct getindex(vi, ::Colon) docstring (#854)#1382
Open
ArpanC6 wants to merge 1 commit intoTuringLang:mainfrom
Open
fix: correct getindex(vi, ::Colon) docstring (#854)#1382ArpanC6 wants to merge 1 commit intoTuringLang:mainfrom
ArpanC6 wants to merge 1 commit intoTuringLang:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1382 +/- ##
=======================================
Coverage 82.35% 82.35%
=======================================
Files 50 50
Lines 3531 3531
=======================================
Hits 2908 2908
Misses 623 623 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
Author
|
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. |
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
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.
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