docs(seo-graph-core): clarify buildPiece takes no IdFactory#52
Open
schlessera wants to merge 1 commit into
Open
docs(seo-graph-core): clarify buildPiece takes no IdFactory#52schlessera wants to merge 1 commit into
schlessera wants to merge 1 commit into
Conversation
The Piece builders section opened with "All builders take an input object and the IdFactory". That holds for the seven dedicated builders (buildWebSite, buildWebPage, buildArticle, buildBreadcrumbList, buildImageObject, buildVideoObject, buildSiteNavigationElement — all `(input, ids)`), but not for buildPiece, whose signature is single-arg `buildPiece(raw)`: the caller passes `@id`/`@type` inline. Call out the exception so readers don't pass a second argument that doesn't exist.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
The Piece builders section of
packages/seo-graph-core/README.mdopens with:That's accurate for the seven dedicated builders, but not for
buildPiece.Evidence (current
src/pieces/)(input, ids: IdFactory):buildWebSite,buildWebPage,buildArticle,buildBreadcrumbList,buildImageObject,buildVideoObject,buildSiteNavigationElementSingle-arg:
buildPiece(raw: Record<string, unknown>)—src/pieces/custom.ts. The caller passes@id/@typeinline in the object.AGENTS.mdalready states this ("the genericbuildPiecebuilder takes only the input object"); the core README didn't.Change
One sentence — note the
buildPieceexception so readers don't pass a secondIdFactoryargument that doesn't exist.Docs-only; no changeset.