Documentation comment not found for function declaration
stripeCheckoutSessionCreate 2
3const stripe = require('stripe')(process.env.STRIPE_SECRET_KEY);
4
5export default async function stripeCheckoutSessionCreate(req, res) { 6 const session = await stripe.checkout.sessions.create({
7 payment_method_types: ['card'],
8 line_items: [Documentation comment not found for arrow function expression
handleSubmit 7 const [isPending, setIsPending] = React.useState(false);
8 const router = useRouter();
9
10 const handleSubmit = async ({ name, email, amount }) => {11 setIsPending(true);
12
13 const response = await fetch('/api/create-stripe-session', {Documentation comment not found for arrow function expression
useStripeSessionWithUserInfo 3
4const dollarsToCentsMultiplier = 100;
5
6const useStripeSessionWithUserInfo = () => { 7 const [isPending, setIsPending] = React.useState(false);
8 const router = useRouter();
9Documentation comment not found for function declaration
EmailCaptureHelper 1import React from 'react';
2
3export default function EmailCaptureHelper({ children, data }) { 4 return (
5 <>
6 <div className="email-title text-4xl pt-5 pl-5">Documentation comment not found for arrow function expression
handleSubmitForm 20 setModalOpen(true);
21 };
22
23 const handleSubmitForm = async (event) => { 24 event.preventDefault();
25
26 if (!name) {Documentation comment not found for arrow function expression
showModal 15
16 const hideModal = () => setModalOpen(false);
17
18 const showModal = (message) => { 19 setModalText(message);
20 setModalOpen(true);
21 };Documentation comment not found for arrow function expression
hideModal 13 const [name, setName] = React.useState('');
14 const [handleSubmit, isPending] = useStripeSessionWithUserInfo();
15
16 const hideModal = () => setModalOpen(false); 17
18 const showModal = (message) => {
19 setModalText(message);Documentation comment not found for function declaration
MainDonation 5import Modal from './Modal';
6import useStripeSessionWithUserInfo from '../hooks/useStripeSessionWithUserInfo';
7
8export default function MainDonation() { 9 const [modalText, setModalText] = React.useState('');
10 const [isModalOpen, setModalOpen] = React.useState(false);
11 const [amount, setAmount] = React.useState(0);Documentation comment not found for function declaration
HeroSectionModified 3
4import MainDonation from './MainDonation';
5
6function HeroSectionModified({ main = false, image, inNeed = false }) { 7 return (
8 <div className={`text-center ${!main && 'hero-content'} md:m-auto`}>
9 {main && (Documentation comment not found for arrow function expression
LineItem 3import React from 'react';
4import { useContextTheme } from 'components/ThemeContext';
5
6const LineItem = ({ title, link }) => ( 7 <li className="mt-2 text-gray-300 md:block md:mr-0">
8 {link ? (
9 <Link href={link || '#'} passHref>Documentation comment not found for arrow function expression
Footer 17 </li>
18);
19
20const Footer = () => { 21 const { theme, cardsBackgroundColor } = useContextTheme();
22
23 return (
Description
It is recommended to have documentation comments above, or right inside a function/class declaration. This helps developers, users and even the author understand the purpose of a code snippet or API function in the future.
NOTE: If you want to stop this issue from getting raised on certain constructs (arrow functions, class expressions, methods etc.), consider using the skipdoccoverage option under the analyzers.meta property in your .deepsource.toml file.
For example, the following configuration will silence this issue for class expressions and method definitions:
[analyzers.meta]
skip_doc_coverage = ["class-expression", "method-definition"]
Bad Practice
function sum(a, b) {
return a + b;
}
Recommended
/**
* Function to add two numbers
* @param a The first number to add
* @param b The second number to add
* @returns The sum of two numbers
*/
function sum(a, b) {
return a + b;
}