LREG: deprecate trans argument
#100
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
nalimilan
reviewed
Jun 8, 2019
docs/source/lreg.rst
Outdated
| @@ -31,7 +31,7 @@ The package provides ``llsq`` to solve these problems: | |||
|
|
|||
| This function accepts two keyword arguments: | |||
|
|
|||
| - ``trans``: whether to use the transposed form. (default is ``false``) | |||
| - ``dims``: whether input observations stored as rows (1) or columns (2). (default is ``2``) | |||
There was a problem hiding this comment.
Suggested change
| - ``dims``: whether input observations stored as rows (1) or columns (2). (default is ``2``) | |
| - ``dims``: whether input observations are stored as rows (``1``) or columns (``2``). (default is ``2``) |
docs/source/lreg.rst
Outdated
| @@ -132,7 +132,7 @@ The package provides ``ridge`` to solve these problems: | |||
|
|
|||
| This function accepts two keyword arguments: | |||
|
|
|||
| - ``trans``: whether to use the transposed form. (default is ``false``) | |||
| - ``dims``: whether input observations stored as rows (1) or columns (2). (default is ``2``) | |||
There was a problem hiding this comment.
Suggested change
| - ``dims``: whether input observations stored as rows (1) or columns (2). (default is ``2``) | |
| - ``dims``: whether input observations are stored as rows (``1``) or columns (``2``). (default is ``2``) |
docs/source/lreg.rst
Outdated
|
|
||
| For a matrix ``Y`` comprised of multiple columns: | ||
| For a matrix column-stored regressors ``X`` and dependent variables comprised of multiple columns ``Y``: |
There was a problem hiding this comment.
The text still says "a matrix" but you mention two matrices, right?
| trans::Bool=false, bias::Bool=true, | ||
| dims::Union{Integer,Nothing}=nothing) where {T<:Real} | ||
| if dims === nothing | ||
| Base.depwarn("`trans` argument is deprecated, use llsq(X, Y, dims=d) instead.", :trans) |
There was a problem hiding this comment.
AFAICT this warning will be printed even if the caller didn't set trans, in which case it will be confusing. I guess it should say that dims is required, and only mention trans if it's true, right?
Also, the default for dims should be 1 until we remove the deprecation, or that will break code.
|
I switched back default |
nalimilan
approved these changes
Sep 4, 2019
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Deprecate
transin favor ofdimsargument