Skip to content

Commit

Permalink
Remove extra lines in property descriptions to avoid :return: expre…
Browse files Browse the repository at this point in the history
…ssions (#683)

* Remove extra lines in property descriptions to avoid `:return:` expressions

* Replace `\n` with `:param obj:` as a creterion for trimming property definitions
  • Loading branch information
louis-md authored Jan 31, 2025
1 parent aab520a commit 6377367
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion components/ApiReference/Property.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ const Property: React.FC<{ property: any; required?: boolean }> = ({
}
}}
>
{property.value?.description}
{property.value?.description?.split(':param obj:')?.[0] ?? ''}
</Typography>
</Grid>
</Grid>
Expand Down

0 comments on commit 6377367

Please sign in to comment.