📝 Add some documentation.

DLR-SC · Mar 21, 2024 · 4f751a9 · 4f751a9
1 parent 9424188
commit 4f751a9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/frontend/src/components/shared/MUILocalization.tsx b/frontend/src/components/shared/MUILocalization.tsx
@@ -6,6 +6,9 @@ import {LocalizationProvider} from '@mui/x-date-pickers/LocalizationProvider';
 import {AdapterDayjs} from '@mui/x-date-pickers/AdapterDayjs';
 import React from 'react';
 
+/**
+ * A utility component to provide localization support for certain MUI elements, like date pickers.
+ */
 export function MUILocalization(props: {children: string | JSX.Element | JSX.Element[]}): JSX.Element {
   const {i18n} = useTranslation();
 

diff --git a/frontend/src/components/shared/MathMarkdown.tsx b/frontend/src/components/shared/MathMarkdown.tsx
@@ -6,6 +6,9 @@ import ReactMarkdown from 'react-markdown';
 import rehypeKatex from 'rehype-katex';
 import remarkMath from 'remark-math';
 
+/**
+ * Renders the given content in a markdown environment that supports mathematical equations.
+ */
 export default function MathMarkdown(props: Readonly<{children: string}>): JSX.Element {
   return (
     <ReactMarkdown remarkPlugins={[remarkMath]} rehypePlugins={[rehypeKatex]}>