doc: fix return type of crypto.getFips()
#32580
Conversation
nodejs-github-bot
added
crypto
|
Matching the doc to the implementation seems like the least effort solution. Our tests for node/test/parallel/test-crypto-fips.js Lines 14 to 15 in c52ebc0 |
@cjihrig Added the non-FIPS value of |
richardlau
added
the
author ready
|
Thanks. Still LGTM. |
|
I assume it would be a breaking change to actually change it to a boolean? |
That was my assumption. |
|
Technically, this LGTM as a documentation fix, I'm just concerned that by documenting the current behavior correctly, fixing the implementation to return a boolean becomes "more breaking". |
It would be semver-major either way so there's really no difference. |
|
@jasnell That’s true as far as our release process is concerned – In terms of communicating with our users, there is a difference between changing behavior that’s documented vs changing behavior that’s undocumented. What I would suggest for this PR is to document that in the future it may become a boolean, and then implement that in a follow-up at some point. |
Added more words to this effect. |
There was a problem hiding this comment.
That's exactly what I mean, and a wonderful suggestion, @addaleax, thank you. And thanks for implementing it, @richardlau!
`crypto.getFips()` returns a number, not a boolean. PR-URL: nodejs#32580 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Signed-off-by: Richard Lau <[email protected]>
Document that the return type of `crypto.getFips()` may change in a future semver-major release from a `number` to a `boolean`. PR-URL: nodejs#32580 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Signed-off-by: Richard Lau <[email protected]>
|
Landed in 83ebd77...b9da063. |
`crypto.getFips()` returns a number, not a boolean. PR-URL: #32580 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Signed-off-by: Richard Lau <[email protected]>
Document that the return type of `crypto.getFips()` may change in a future semver-major release from a `number` to a `boolean`. PR-URL: #32580 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Signed-off-by: Richard Lau <[email protected]>
`crypto.getFips()` returns a number, not a boolean. PR-URL: #32580 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Signed-off-by: Richard Lau <[email protected]>
Document that the return type of `crypto.getFips()` may change in a future semver-major release from a `number` to a `boolean`. PR-URL: #32580 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Signed-off-by: Richard Lau <[email protected]>
`crypto.getFips()` returns a number, not a boolean. PR-URL: #32580 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Signed-off-by: Richard Lau <[email protected]>
Document that the return type of `crypto.getFips()` may change in a future semver-major release from a `number` to a `boolean`. PR-URL: #32580 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Signed-off-by: Richard Lau <[email protected]>
crypto.getFips()returns a number, not a boolean.cc @danbev @nodejs/crypto
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes