DOC: Fix io.loadmat docstring for mdict param #5768
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 docs spell the parameter as `m_dict`; it is `mdict`. Another issue: I think the parameter is weirdly explained. Instead of "Dictionary from which to save matfile variables.", shouldn't it be "Dictionary to which to save matfile variables."?
jona-sassenhagen
changed the title
@@ master #5768 diff @@
======================================
Files 235 235
Stmts 43281 43281
Branches 8163 8163
Methods 0 0
======================================
Hit 33609 33609
Partial 2598 2598
Missed 7074 7074
|
|
Thanks for this change. I'm not sure what you mean about the explanation - the current text is "Dictionary in which to insert matfile variables.", no? |
|
Ah - my confusion, sorry. I had mixed this up with |
|
LGTM; but do we want the commits squashed and the question edited out? The version control log isn't really the place for those, they might confuse future developers. |
|
Can you squash on master? I'm on my phone right now. Will edit the post later. |
you can squash them locally and force-push to the branch you made this PR from. |
pv
added a commit
that referenced
this pull request
Feb 15, 2016
DOC: io: fix io.loadmat docstring for mdict param
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.
The docs spell the parameter as
m_dict; it ismdict.Another issue: I think the parameter is weirdly explained. Instead of "Dictionary from which to save matfile variables.", shouldn't it be "Dictionary to which to save matfile variables."?