Commit 38644d6
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 <duhamelantoine1995@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>1 parent 727c2bc commit 38644d6
1 file changed
Lines changed: 5 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,4 +1,4 @@ | |||
| 1 | - # Node.js src/crypto Documentation | ||
| 1 | + # Node.js `src/crypto` documentation | ||
| 2 | 2 | ||
| 3 | 3 | Welcome. You've found your way to the Node.js native crypto subsystem. | |
| 4 | 4 | ||
@@ -64,7 +64,7 @@ instead.) | |||
| 64 | 64 | This section aims to explain some of the utilities that have been | |
| 65 | 65 | provided to make working with the OpenSSL APIs a bit easier. | |
| 66 | 66 | ||
| 67 | - ### Pointer Types | ||
| 67 | + ### Pointer types | ||
| 68 | 68 | ||
| 69 | 69 | Most of the key OpenSSL types need to be explicitly freed when they are | |
| 70 | 70 | 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). | |||
| 123 | 123 | to directly using the `v8::BackingStore` API. This will take some time. | |
| 124 | 124 | New uses of `AllocatedBuffer` should be avoided if possible.* | |
| 125 | 125 | ||
| 126 | - ### Key Objects | ||
| 126 | + ### Key objects | ||
| 127 | 127 | ||
| 128 | 128 | Most crypto operations involve the use of keys -- cryptographic inputs | |
| 129 | 129 | 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, | |||
| 272 | 272 | like `THROW_ERR_CRYPTO_INVALID_IV(env)`. These methods | |
| 273 | 273 | should be used to throw JavaScript errors when necessary. | |
| 274 | 274 | ||
| 275 | - ## Crypto API Patterns | ||
| 275 | + ## Crypto API patterns | ||
| 276 | 276 | ||
| 277 | - ### Operation Mode | ||
| 277 | + ### Operation mode | ||
| 278 | 278 | ||
| 279 | 279 | All crypto functions in Node.js operate in one of three | |
| 280 | 280 | modes: | |
0 commit comments