Update LinkTopic.tsx

2024-10-31 15:21:21 +03:00 · 2024-10-31 15:21:21 +03:00 · abca112b28
commit abca112b28
parent 26a74202a1
1 changed files with 5 additions and 0 deletions
--- a/rsconcept/frontend/src/components/ui/LinkTopic.tsx
+++ b/rsconcept/frontend/src/components/ui/LinkTopic.tsx
@ -4,10 +4,15 @@ import { HelpTopic } from '@/models/miscellaneous';
 import TextURL from './TextURL';

 interface TextURLProps {
+  /** Text to display. */
  text: string;
+  /** Topic to link to. */
  topic: HelpTopic;
 }

+/**
+ * Displays a link to a help topic.
+ */
 function LinkTopic({ text, topic }: TextURLProps) {
  return <TextURL text={text} href={urls.help_topic(topic)} />;
 }