Fix: base class metadata lost for API pages #13842
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
What was wrong
`apiDetails.baseClass` in [website/pages/[...listPathPage].tsx](cci:7://file:///c:/Users/T2430514/Downloads/spaCy/website/pages/%5B...listPathPage%5D.tsx:0:0-0:0) was hard-coded to `null`, ignoring the `api_base_class` and `api_base_class_title` values provided in page front-matter.
As a result, API reference pages could not render “extends …” information or generate correct cross-links, hurting usability and discoverability of the docs.
## How it’s fixed
The placeholder line was replaced with real logic:
```ts
const baseClass = mdx.frontmatter.api_base_class
? {
title: mdx.frontmatter.api_base_class_title ?? mdx.frontmatter.title,
slug: mdx.frontmatter.api_base_class,
}
: null;
```
apiDetails.baseClass now receives this object, allowing the UI to show accurate base-class data whenever it’s supplied, while still defaulting to null when it isn’t.
Co-Authored-By: S. M. Mohiuddin Khan Shiam <[email protected]>
What was wrong
`apiDetails.baseClass` in [website/pages/[...listPathPage].tsx](cci:7://file:///c:/Users/T2430514/Downloads/spaCy/website/pages/%5B...listPathPage%5D.tsx:0:0-0:0) was hard-coded to `null`, ignoring the `api_base_class` and `api_base_class_title` values provided in page front-matter.
As a result, API reference pages could not render “extends …” information or generate correct cross-links, hurting usability and discoverability of the docs.
## How it’s fixed
The placeholder line was replaced with real logic:
```ts
const baseClass = mdx.frontmatter.api_base_class
? {
title: mdx.frontmatter.api_base_class_title ?? mdx.frontmatter.title,
slug: mdx.frontmatter.api_base_class,
}
: null;
```
apiDetails.baseClass now receives this object, allowing the UI to show accurate base-class data whenever it’s supplied, while still defaulting to null when it isn’t.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What was wrong
apiDetails.baseClassin website/pages/[...listPathPage].tsx was hard-coded tonull, ignoring theapi_base_classandapi_base_class_titlevalues provided in page front-matter.As a result, API reference pages could not render “extends …” information or generate correct cross-links, hurting usability and discoverability of the docs.
How it’s fixed
The placeholder line was replaced with real logic:
apiDetails.baseClass now receives this object, allowing the UI to show accurate base-class data whenever it’s supplied, while still defaulting to null when it isn’t.