Skip to content

Commit 38644d6

Browse files
Trotttargos
authored andcommitted
doc: use sentence case in headers in src/crypto/README.md
Use sentence case consistently in headers in src/crypto/README.md. PR-URL: #38524 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Zijian Liu <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
1 parent 727c2bc commit 38644d6

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/crypto/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Node.js src/crypto Documentation
1+
# Node.js `src/crypto` documentation
22

33
Welcome. You've found your way to the Node.js native crypto subsystem.
44

@@ -64,7 +64,7 @@ instead.)
6464
This section aims to explain some of the utilities that have been
6565
provided to make working with the OpenSSL APIs a bit easier.
6666

67-
### Pointer Types
67+
### Pointer types
6868

6969
Most of the key OpenSSL types need to be explicitly freed when they are
7070
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).
123123
to directly using the `v8::BackingStore` API. This will take some time.
124124
New uses of `AllocatedBuffer` should be avoided if possible.*
125125

126-
### Key Objects
126+
### Key objects
127127

128128
Most crypto operations involve the use of keys -- cryptographic inputs
129129
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,
272272
like `THROW_ERR_CRYPTO_INVALID_IV(env)`. These methods
273273
should be used to throw JavaScript errors when necessary.
274274

275-
## Crypto API Patterns
275+
## Crypto API patterns
276276

277-
### Operation Mode
277+
### Operation mode
278278

279279
All crypto functions in Node.js operate in one of three
280280
modes:

0 commit comments

Comments
 (0)