-
Notifications
You must be signed in to change notification settings - Fork 5
Typo in errors #153
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Typo in errors #153
Conversation
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
|
Your PR requires formatting changes to meet the project's style guidelines. Click here to view the suggested changes.diff --git a/src/interface/decompositions.jl b/src/interface/decompositions.jl
index e8e1021..88d5b80 100644
--- a/src/interface/decompositions.jl
+++ b/src/interface/decompositions.jl
@@ -411,11 +411,11 @@ LeftOrthAlgorithm{Kind}(alg::Alg) where {Kind, Alg <: AbstractAlgorithm} = LeftO
# Note: specific algorithm selection is handled by `left_orth_alg` in orthnull.jl
LeftOrthAlgorithm(alg::AbstractAlgorithm) = error(
"""
- Unknown or invalid `left_orth` algorithm type `$(typeof(alg))`.
+ Unknown or invalid `left_orth` algorithm type `$(typeof(alg))`.
To register the algorithm type for `left_orth`, define
-
+
MatrixAlgebraKit.left_orth_alg(alg::CustomAlgorithm) = LeftOrthAlgorithm{kind}(alg)
-
+
where `kind` selects the factorization type that will be used.
By default, this is either `:qr`, `:polar` or `:svd`, to select [`qr_compact!`](@ref),
[`left_polar!`](@ref), [`svd_compact!`](@ref) or [`svd_trunc!`](@ref) respectively.
@@ -440,11 +440,11 @@ RightOrthAlgorithm{Kind}(alg::Alg) where {Kind, Alg <: AbstractAlgorithm} = Righ
# Note: specific algorithm selection is handled by `right_orth_alg` in orthnull.jl
RightOrthAlgorithm(alg::AbstractAlgorithm) = error(
"""
- Unknown or invalid `right_orth` algorithm type `$(typeof(alg))`.
+ Unknown or invalid `right_orth` algorithm type `$(typeof(alg))`.
To register the algorithm type for `right_orth`, define
-
+
MatrixAlgebraKit.right_orth_alg(alg::CustomAlgorithm) = RightOrthAlgorithm{kind}(alg)
-
+
where `kind` selects the factorization type that will be used.
By default, this is either `:lq`, `:polar` or `:svd`, to select [`lq_compact!`](@ref),
[`right_polar!`](@ref), [`svd_compact!`](@ref) or [`svd_trunc!`](@ref) respectively.
@@ -469,11 +469,11 @@ LeftNullAlgorithm{Kind}(alg::Alg) where {Kind, Alg <: AbstractAlgorithm} = LeftN
# Note: specific algorithm selection is handled by `left_null_alg` in orthnull.jl
LeftNullAlgorithm(alg::AbstractAlgorithm) = error(
"""
- Unknown or invalid `left_null` algorithm type `$(typeof(alg))`.
+ Unknown or invalid `left_null` algorithm type `$(typeof(alg))`.
To register the algorithm type for `left_null`, define
-
+
MatrixAlgebraKit.left_null_alg(alg::CustomAlgorithm) = LeftNullAlgorithm{kind}(alg)
-
+
where `kind` selects the factorization type that will be used.
By default, this is either `:qr` or `:svd`, to select [`qr_null!`](@ref),
[`svd_compact!`](@ref) or [`svd_trunc!`](@ref) respectively.
@@ -497,11 +497,11 @@ RightNullAlgorithm{Kind}(alg::Alg) where {Kind, Alg <: AbstractAlgorithm} = Righ
# Note: specific algorithm selection is handled by `right_null_alg` in orthnull.jl
RightNullAlgorithm(alg::AbstractAlgorithm) = error(
"""
- Unknown or invalid `right_null` algorithm type `$(typeof(alg))`.
+ Unknown or invalid `right_null` algorithm type `$(typeof(alg))`.
To register the algorithm type for `right_null`, define
-
+
MatrixAlgebraKit.right_null_alg(alg::CustomAlgorithm) = RightNullAlgorithm{kind}(alg)
-
+
where `kind` selects the factorization type that will be used.
By default, this is either `:lq` or `:svd`, to select [`lq_null!`](@ref),
[`svd_compact!`](@ref) or [`svd_trunc!`](@ref) respectively.
diff --git a/src/interface/orthnull.jl b/src/interface/orthnull.jl
index 1ef84c4..ff6d29f 100644
--- a/src/interface/orthnull.jl
+++ b/src/interface/orthnull.jl
@@ -429,11 +429,11 @@ See also [`LeftOrthAlgorithm`](@ref), [`left_orth`](@ref).
"""
left_orth_alg(alg::AbstractAlgorithm) = error(
"""
- Unknown or invalid `left_orth` algorithm type `$(typeof(alg))`.
+ Unknown or invalid `left_orth` algorithm type `$(typeof(alg))`.
To register the algorithm type for `left_orth`, define
-
+
MatrixAlgebraKit.left_orth_alg(alg::CustomAlgorithm) = LeftOrthAlgorithm{kind}(alg)
-
+
where `kind` selects the factorization type that will be used.
By default, this is either `:qr`, `:polar` or `:svd`, to select [`qr_compact!`](@ref),
[`left_polar!`](@ref), [`svd_compact!`](@ref) or [`svd_trunc!`](@ref) respectively.
@@ -464,11 +464,11 @@ See also [`RightOrthAlgorithm`](@ref), [`right_orth`](@ref).
"""
right_orth_alg(alg::AbstractAlgorithm) = error(
"""
- Unknown or invalid `right_orth` algorithm type `$(typeof(alg))`.
+ Unknown or invalid `right_orth` algorithm type `$(typeof(alg))`.
To register the algorithm type for `right_orth`, define
-
+
MatrixAlgebraKit.right_orth_alg(alg::CustomAlgorithm) = RightOrthAlgorithm{kind}(alg)
-
+
where `kind` selects the factorization type that will be used.
By default, this is either `:lq`, `:polar` or `:svd`, to select [`lq_compact!`](@ref),
[`right_polar!`](@ref), [`svd_compact!`](@ref) or [`svd_trunc!`](@ref) respectively.
@@ -499,11 +499,11 @@ See also [`LeftNullAlgorithm`](@ref), [`left_null`](@ref).
"""
left_null_alg(alg::AbstractAlgorithm) = error(
"""
- Unknown or invalid `left_null` algorithm type `$(typeof(alg))`.
+ Unknown or invalid `left_null` algorithm type `$(typeof(alg))`.
To register the algorithm type for `left_null`, define
-
+
MatrixAlgebraKit.left_null_alg(alg::CustomAlgorithm) = LeftNullAlgorithm{kind}(alg)
-
+
where `kind` selects the factorization type that will be used.
By default, this is either `:qr` or `:svd`, to select [`qr_null!`](@ref),
[`svd_compact!`](@ref) or [`svd_trunc!`](@ref) respectively.
@@ -533,11 +533,11 @@ See also [`RightNullAlgorithm`](@ref), [`right_null`](@ref).
"""
right_null_alg(alg::AbstractAlgorithm) = error(
"""
- Unknown or invalid `right_null` algorithm type `$(typeof(alg))`.
+ Unknown or invalid `right_null` algorithm type `$(typeof(alg))`.
To register the algorithm type for `right_null`, define
-
+
MatrixAlgebraKit.right_null_alg(alg::CustomAlgorithm) = RightNullAlgorithm{kind}(alg)
-
+
where `kind` selects the factorization type that will be used.
By default, this is either `:lq` or `:svd`, to select [`lq_null!`](@ref),
[`svd_compact!`](@ref) or [`svd_trunc!`](@ref) respectively. |
Member
Author
|
The formatter is not being kind to me |
Member
|
You can ignore the formatter, this is a bug in git-runic |
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.
No description provided.