Skip to content

Commit

Permalink
fixed some linting errors, mostly jsdocs (#69)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidqing6432 authored May 22, 2024
1 parent a694efd commit 6b1cef2
Show file tree
Hide file tree
Showing 13 changed files with 51 additions and 340 deletions.
6 changes: 0 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/app/hoursAdmissionPage/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export default function HoursAdmissionPage() {
</div>
</div>
<p className="text-night font-normal font-lato pl-[1.31rem]">
If you've found a wild animal that appears to be sick, injured, or
If you&apos;ve found a wild animal that appears to be sick, injured, or
orphaned, safely contain it and either bring it to our nearest shelter
or contact us for guidance.
</p>
Expand Down
18 changes: 9 additions & 9 deletions src/app/spotlightPage/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -82,25 +82,25 @@ function App() {
className="w-[24.375rem] h-[13.375rem] rounded-lg"
key={
media.find(
m =>
m.id ===
allTourMedia.find(m => m.tour_id === spotlight.id)
mediaElement =>
mediaElement.id ===
allTourMedia.find(allTourMediaElement => allTourMediaElement.tour_id === spotlight.id)
?.media_id,
)?.id
}
src={
media.find(
m =>
m.id ===
allTourMedia.find(m => m.tour_id === spotlight.id)
mediaElement =>
mediaElement.id ===
allTourMedia.find(allTourMediaElement => allTourMediaElement.tour_id === spotlight.id)
?.media_id,
)?.url ?? ''
}
alt={
media.find(
m =>
m.id ===
allTourMedia.find(m => m.tour_id === spotlight.id)
mediaElement =>
mediaElement.id ===
allTourMedia.find(allTourMediaElement => allTourMediaElement.tour_id === spotlight.id)
?.media_id,
)?.text ?? ''
}
Expand Down
14 changes: 14 additions & 0 deletions src/components/userComponents/ExhibitDisplay/ExhibitDisplay.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@ import React from 'react';
import Image from 'next/image';
import styles from './ExhibitDisplay.module.css';

/**
* ExhibitDisplay component
* @param props - props for the ExhibitDisplay component
* @param props.name - name of the exhibit
* @param props.location - location of the exhibit
* @param props.information - information about the exhibit
* @param props.description - description of the exhibit
* @param props.relatednews - related news of the exhibit
* @param props.topimage - top image of the exhibit
* @param props.media - media of the exhibit
* @param props.bottomimage - bottom image of the exhibit
* @param props.moretext - more text of the exhibit
* @returns JSX.Element
*/
export default function ExhibitDisplay({
name,
location,
Expand Down
135 changes: 0 additions & 135 deletions src/components/userComponents/ExhibitPreview/ExhibitPreview 2.tsx

This file was deleted.

This file was deleted.

13 changes: 13 additions & 0 deletions src/components/userComponents/ExhibitPreview/ExhibitPreview.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,19 @@ import Image from 'next/image';
import Link from 'next/link';
import styles from './ExhibitPreview.module.css';


/**
*
* @param props - props for the ExhibitPreview component
* @param props.name - name of the exhibit
* @param props.location - location of the exhibit
* @param props.description - description of the exhibit
* @param props.about - about the exhibit
* @param props.topimage - top image of the exhibit
* @param props.bottomimage - bottom image of the exhibit
* @param props.href - href of the exhibit
* @returns JSX.Element
*/
export default function ExhibitPreview({
name,
location,
Expand Down
9 changes: 5 additions & 4 deletions src/components/userComponents/FilterButton/FilterButton.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@ interface FilterButtonProps {

/**
*
* @param root0
* @param root0.content
* @param root0.onClick
* @param root0.isSelected
* @param props - props for the FilterButton component
* @param props.content - content of the button
* @param props.onClick - function to handle the functionality we want to tie to our filter buttons
* @param props.isSelected - boolean to determine if the button is selected
* @returns JSX.Element
*/
function FilterButton({ content, onClick, isSelected }: FilterButtonProps) {
const selectedStyle =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ import AdmissionButton from './AdmissionButton';
/**
* @returns - Visitor resources section of the home page. Users can reach the Site Map and QR flow from here.
* These resources are mainly for in-person experiences
// eslint-disable-next-line jsdoc/check-tag-names
* @Note VisitorResources tag below uses padding to ensure relative consistency of text lining up with buttons.
* NOTE: VisitorResources tag below uses padding to ensure relative consistency of text lining up with buttons.
* It will look slightly off on some screens. Motivation: it's better to be slightly wrong on many screens
* than VERY wrong on a few. If solution found, @andreiTan
*/
Expand Down
Loading

0 comments on commit 6b1cef2

Please sign in to comment.