You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adds optional id props to PageGrid and PageContent components to improve layout accessibility. No issues found.
✅ 1 resolved✅ Quality: New id public props lack required TSDoc comments
📄 src/components/layout/LayoutSlots.tsx:106📄 src/components/layout/LayoutSlots.tsx:206
The custom review conventions require a /** */ doc comment on every field of a public props interface. The newly added id?: string; props on PageGridProps (LayoutSlots.tsx:106) and PageContentProps (LayoutSlots.tsx:206) are undocumented. Add a TSDoc comment to each, e.g. describing that the id is applied to the underlying container element.
Note: the props are correctly forwarded to the underlying elements via ...restProps in both PageGrid and PageContent, so functionality is fine — this is purely a documentation-convention gap. (The pre-existing className and AsideProps.id are outside this diff.)
Options
Auto-apply is off → Gitar will not commit updates to this branch. Display: compact → Showing less information.
Comment with these commands to change the behavior for this request:
Understood — id is certainly intuitive, but the project convention (defined in .gitar/review/naming-and-api.md) requires a TSDoc comment on every field of a public props interface, regardless of how self-explanatory it is. Consistent documentation makes IDE hover-docs and auto-generated API references complete without exceptions.
That said, if the team wants to relax this rule for widely-known HTML-attribute props like id, className, etc., that would be a reasonable policy change to make in the .gitar/review/naming-and-api.md convention file. For now I'll flag it as-is per the current rule.
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
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.
Summary by Gitar
idprop toPageGridPropsinterface inLayoutSlots.tsx.idprop toPageContentPropsinterface inLayoutSlots.tsx.This will update automatically on new commits.