Skip to content

Commit

Permalink
docs: add and update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
yumincho committed Mar 17, 2024
1 parent 4753b6e commit 89a3a74
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 6 deletions.
4 changes: 1 addition & 3 deletions src/components/blocks/CourseBlock.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,8 @@ interface Props {
}

/**
*
* Component `CourseBlock` displays a overview of a course in `DictionaryPage`.
* Component `CourseBlock` displays an overview of a course within the search results on the `DictionaryPage`.
* It shows the title, classification, professors, and description of the course.
*
*/
const CourseBlock: React.FC<Props> = ({
t,
Expand Down
4 changes: 4 additions & 0 deletions src/components/blocks/CourseSimpleBlock.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ interface Props {
course: Course;
}

/**
* Component `CourseSimpleBlock` displays a brief overview of a course within the `CourseRelatedCoursesSubSection` on the `DictionaryPage`.
* It shows the title and code of the course.
*/
const CourseSimpleBlock: React.FC<Props> = ({ course }) => {
const translate = useTranslatedString();

Expand Down
4 changes: 4 additions & 0 deletions src/components/blocks/PlannerCourseBlock.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ interface Props {
addToPlanner: (course: Course | ArbitraryPseudoCourse) => void;
}

/**
* Component `PlannerCourseBlock` displays an overview of a course within the search results on the `PlannerPage`.
* It shows the title, classification, and code of the course.
*/
const PlannerCourseBlock: React.FC<Props> = ({
t,
course,
Expand Down
4 changes: 1 addition & 3 deletions src/components/blocks/ProjectBlock.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,8 @@ interface Props {
}

/**
*
* Component `ProjectBlock` displays an overview of a project in `CreditPage`.
* Component `ProjectBlock` displays an overview of a project on the `CreditPage`.
* It shows the title, subtitle, and period of the project.
*
*/
const ProjectBlock: React.FC<Props> = ({ project, isRaised, onClick }) => {
const handleClick = onClick
Expand Down

0 comments on commit 89a3a74

Please sign in to comment.