Skip to content

Commit 43b346e

Browse files
committed
fix(tsdocs): use model.name as canonicalReference is removed
1 parent ee57721 commit 43b346e

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

packages/tsdocs/src/__tests__/acceptance/tsdocs.acceptance.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,5 +134,13 @@ permalink: /doc/en/lb4/apidocs.index.html
134134
'utf-8',
135135
);
136136
expect(constructorDoc).to.not.match(/\.\(constructor\)\.md/);
137+
138+
const pkgDoc = await fs.readFile(
139+
path.join(SITE_APIDOCS_ROOT, 'pkg1.md'),
140+
'utf-8',
141+
);
142+
expect(pkgDoc).to.match(
143+
/\[pkg1\]\(https\:\/\/github\.com\/strongloop\/loopback\-next\/tree\/master\/packages\/pkg1\)/,
144+
);
137145
});
138146
});

packages/tsdocs/src/update-api-md-docs.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ async function addJekyllMetadata(
145145
const model = await fs.readJson(modelFile, {encoding: 'utf-8'});
146146
debug('Package %s', name, model);
147147
if (model.kind === 'Package' && !model.docComment) {
148-
const pkgDoc = `[${model.canonicalReference}](https://github.com/strongloop/loopback-next/tree/master/packages/${name})`;
148+
const pkgDoc = `[${model.name}](https://github.com/strongloop/loopback-next/tree/master/packages/${name})`;
149149
doc = doc.replace(
150150
`## ${name} package`,
151151
`## ${name} package\n\n${pkgDoc}`,

0 commit comments

Comments
 (0)