Skip to content

Fix calculateTotal JavaScript example in documentation guidelines #648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix calculateTotal JavaScript example in documentation guidelines #648

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/tone_of_voice.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,17 @@ Data over description - Show metrics, not marketing.
Write complete, runnable examples with error handling, expected outputs, and realistic values (use environment variables, not placeholders).

```javascript
const apiKey = process.env.API_KEY;
function calculateTotal(numbers) {
if (!Array.isArray(numbers)) {
throw new Error('Input must be an array');
}
if (!numbers.every((num) => typeof num === 'number' && !Number.isNaN(num) && isFinite(num))) {
throw new Error('Input must contain only finite numbers');
}
return numbers.reduce((sum, num) => sum + num, 0);
}

const apiKey = process.env.API_KEY; // Use only if needed for API calls

try {
const result = calculateTotal([10, 20, 30]);
Expand Down