Skip to content

docs(science): fix typo in Unit.symbol - #3917

Merged
ST-DDT merged 1 commit into
faker-js:nextfrom
hiSandog:fix/typo-cleanup-20260625
Jun 25, 2026
Merged

ST-DDT merged 1 commit into
faker-js:nextfrom
hiSandog:fix/typo-cleanup-20260625

Conversation

@hiSandog

Copy link
Copy Markdown
Contributor

Description

The Unit interface in src/modules/science/index.ts had an incorrect JSDoc comment on the symbol property. It read "The short version/abbreviation of the element" but should say "The short version/abbreviation of the unit" since this property belongs to the Unit interface, not the ChemicalElement interface.

Changes

  • Fixed copy-paste error in JSDoc comment for Unit.symbol property in the science module.

Validation

  • TypeScript compilation of the science module passes with no errors.
@hiSandog
hiSandog requested a review from a team as a code owner June 25, 2026 02:33
@netlify

netlify Bot commented Jun 25, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for fakerjs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 3c62ca4
🔍 Latest deploy log https://app.netlify.com/projects/fakerjs/deploys/6a3c938b6523d100087e516d
😎 Deploy Preview https://deploy-preview-3917.fakerjs.dev
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@codecov

codecov Bot commented Jun 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.84%. Comparing base (4798749) to head (3c62ca4).

Additional details and impacted files
@@           Coverage Diff           @@
##             next    #3917   +/-   ##
=======================================
  Coverage   98.84%   98.84%           
=======================================
  Files         914      914           
  Lines        3215     3215           
  Branches      591      591           
=======================================
  Hits         3178     3178           
  Misses         33       33           
  Partials        4        4           
Files with missing lines Coverage Δ
src/modules/science/index.ts 100.00% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent m: science Something is referring to the science module labels Jun 25, 2026
@ST-DDT ST-DDT added this to the v10.x milestone Jun 25, 2026
@ST-DDT ST-DDT changed the title fix(science): correct Unit.symbol JSDoc to say 'unit' instead of 'element' Jun 25, 2026
@ST-DDT
ST-DDT requested a review from Copilot June 25, 2026 04:51

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes an incorrect JSDoc description on Unit.symbol in the science module so it correctly refers to a unit (not an element), aligning documentation with the Unit interface semantics.

Changes:

  • Corrected the Unit.symbol JSDoc text from “element” to “unit”.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@ST-DDT
ST-DDT added this pull request to the merge queue Jun 25, 2026
Merged via the queue into faker-js:next with commit d2a54a2 Jun 25, 2026
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

c: docs Improvements or additions to documentation m: science Something is referring to the science module p: 1-normal Nothing urgent

4 participants