docs(*): fix problems with sample code in documentation (#4572)

pnpm · Apr 14, 2022 · afacf01 · afacf01
1 parent d50240f
commit afacf01
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 8 deletions.
diff --git a/packages/fetcher-base/README.md b/packages/fetcher-base/README.md
@@ -17,17 +17,17 @@ pnpm add @pnpm/fetcher-base
 Here's a template for a fetcher using types from `@pnpm/fetcher-base`:
 
 ```ts
-import {Resolution} from '@pnpm/resolver-base'
+import { Resolution } from '@pnpm/resolver-base'
 import {
   FetchOptions,
   FetchResult,
 } from '@pnpm/fetcher-base'
 
-export async function (
+export async function demoFetcher (
   resolution: Resolution,
   targetFolder: string,
   opts: FetchOptions,
-): Promise<FetchResult>
+): Promise<FetchResult> {
   // ...
   return {
     filesIndex,

diff --git a/packages/modules-yaml/README.md b/packages/modules-yaml/README.md
@@ -18,7 +18,7 @@ pnpm add @pnpm/modules-yaml
 import {write, read} from '@pnpm/modules-yaml'
 
 await write('node_modules', {
-  hoistedAliases: {}
+  hoistedAliases: {},
   layoutVersion: 1,
   packageManager: 'pnpm@1.0.0',
   pendingBuilds: [],

diff --git a/packages/resolver-base/README.md b/packages/resolver-base/README.md
@@ -23,7 +23,7 @@ import {
   WantedDependency,
 } from '@pnpm/resolver-base'
 
-export async function (
+export async function testResolver (
   wantedDependency: WantedDependency,
   opts: ResolveOptions,
 ): Promise<ResolveResult> {

diff --git a/packages/symlink-dependency/README.md b/packages/symlink-dependency/README.md
@@ -15,7 +15,6 @@ import symlinkDependency from '@pnpm/symlink-dependency'
 
 await symlinkDependency('/home/src/foo', '/home/src/my-project/node_modules', 'foo')
 //> { reused: false }
-}
 ```
 
 ## License

diff --git a/privatePackages/assert-project/README.md b/privatePackages/assert-project/README.md
@@ -14,7 +14,7 @@ pnpm install -D @pnpm/assert-project
 import test = require('tape')
 import assertProject from '@pnpm/assert-project'
 
-test('...', t => {
+test('...', async t => {
   // ...
   const project = assertProject(t, pathToProject)
 

diff --git a/privatePackages/assert-store/README.md b/privatePackages/assert-store/README.md
@@ -14,7 +14,7 @@ pnpm install -D @pnpm/assert-store
 import test = require('tape')
 import assertStore from '@pnpm/assert-store'
 
-test('...', t => {
+test('...', async t => {
   // ...
   const store = assertStore(t, pathToStore, encodedRegistryName)