From 38644d6f969d8473f2ebf06c06581273aeb4c713 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 3 May 2021 15:29:20 -0700 Subject: [PATCH] doc: use sentence case in headers in src/crypto/README.md Use sentence case consistently in headers in src/crypto/README.md. PR-URL: https://github.com/nodejs/node/pull/38524 Reviewed-By: Antoine du Hamel Reviewed-By: Colin Ihrig Reviewed-By: Zijian Liu Reviewed-By: Gireesh Punathil --- src/crypto/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/crypto/README.md b/src/crypto/README.md index 3317334cd71d3c..479ac3378ef7d0 100644 --- a/src/crypto/README.md +++ b/src/crypto/README.md @@ -1,4 +1,4 @@ -# Node.js src/crypto Documentation +# Node.js `src/crypto` documentation Welcome. You've found your way to the Node.js native crypto subsystem. @@ -64,7 +64,7 @@ instead.) This section aims to explain some of the utilities that have been provided to make working with the OpenSSL APIs a bit easier. -### Pointer Types +### Pointer types Most of the key OpenSSL types need to be explicitly freed when they are no longer needed. Failure to do so introduces memory leaks. To make this @@ -123,7 +123,7 @@ crypto functions (generated hash values, or ciphertext, for instance). to directly using the `v8::BackingStore` API. This will take some time. New uses of `AllocatedBuffer` should be avoided if possible.* -### Key Objects +### Key objects Most crypto operations involve the use of keys -- cryptographic inputs that protect data. There are three general types of keys: @@ -272,9 +272,9 @@ These can be called from within the C++ code as functions, like `THROW_ERR_CRYPTO_INVALID_IV(env)`. These methods should be used to throw JavaScript errors when necessary. -## Crypto API Patterns +## Crypto API patterns -### Operation Mode +### Operation mode All crypto functions in Node.js operate in one of three modes: