Update blobs docs (#352) #464
Merged
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
The blobs docs were found to be a bit confusing by some users (including me). This merge request updates them following the discussion in dfm#352 to clarify how this interface can be used and the intent behind it.
|
Thank you!! |
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.
Firstly, massive thanks to @dfm for all your efforts with emcee, it is an amazing tool and community and has made a massive difference to my (and I'm sure many others') research.
Second, thanks to @steven-murray and @lboogaard for your comments in #352. I was also confused by this and your observations were super helpful.
I think this MR will close #352. It is a pretty basic update to the blobs docs to fix a couple of typos and add some more context which I would have found helpful in hindsight and addresses the things brought up in #352 I believe.