ssl: Fix typespec for signature_algs/2 and export signature_algs/0 type #7841
Conversation
CT Test ResultsNo tests were run for this PR. This is either because the build failed, or the PR is based on a branch without GH actions tests configured. Results for commit 5d4691c To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass. See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally. Artifacts
// Erlang/OTP Github Action Bot |
| @@ -1108,7 +1109,7 @@ append_cipher_suites(Filters, Suites) -> | |||
| (Suites -- Deferred) ++ Deferred. | |||
|
|
|||
| %%-------------------------------------------------------------------- | |||
| -spec signature_algs(Description, Version) -> [signature_algs()] when | |||
| -spec signature_algs(Description, Version) -> signature_algs() when | |||
There was a problem hiding this comment.
On a related note: This function may also return {error, term()}. It seems a little unfortunate to make the spec signature_algs() | {error, reason()}, since that doesn't exactly align with the common style.
There was a problem hiding this comment.
Humm ... I think the error cases was added later, and I think the correct way for this function will be to change the error cases to erlang:error(Reason) so that you get a better error reason than function clause. Please add that to the PR?
There was a problem hiding this comment.
Yes, that makes sense. I've updated the PR.
|
The github actions failure are due to errors in the github scripts that should now be fixed. Please rebase your branch to latest maint and they should be solved. Thanks. |
ahovgaard
force-pushed
the
ssl/fix-signature-algs-spec
branch
from
5d4691c
to
cef4cd0
Compare
ahovgaard
force-pushed
the
ssl/fix-signature-algs-spec
branch
from
cef4cd0
to
e1ef127
Compare
IngelaAndin
added
the
testing
|
Thank you for the PR |
The type
signature_algs/0is already a list, so the return type forsignature_algs/2should just besignature_algs/0.Additionally, export the type since it's used in a spec of an exported function and it's already documented.