docs: improve finance jsdocs

[ST-DDT]

Ref: #203

[codecov]

Codecov Report

Merging #434 (46efb30) into main (3ec32a3) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #434   +/-   ##
=======================================
  Coverage   99.32%   99.32%           
=======================================
  Files        1920     1920           
  Lines      174047   174086   +39     
  Branches      895      895           
=======================================
+ Hits       172876   172916   +40     
+ Misses       1115     1114    -1     
  Partials       56       56           

Impacted Files	Coverage Δ
src/definitions/finance.ts	100.00% <100.00%> (ø)
src/finance.ts	99.33% <100.00%> (+0.06%)	⬆️
src/helpers.ts	99.47% <0.00%> (+0.17%)	⬆️

[Shinigami92]

bcoe/c8#182

@bcoe @j03m
/cc @antfu

Did we misc-configured something in our vite.config.ts

faker/vite.config.ts

Lines 1 to 14 in 832bf8a

	/// <reference types="vitest" />
	import { defineConfig } from 'vite';
	// https://vitejs.dev/config/
	export default defineConfig({
	test: {
	coverage: {
	all: true,
	reporter: ['clover', 'cobertura', 'lcov', 'text'],
	// TODO christopher 2022-02-04: Later we will only cover `src` instead of `dist` and `src`
	include: ['dist', 'src'],
	},
	},
	});

Or is it really a bug by c8 that JSDoc multi-line comments are count as needs to be covered by tests? 👀
If so, this could be a huge bummer for vitest 😬

[bcoe]

@Shinigami92 I would take a look at the .js generated from the .ts file, sometimes there's an unexpected code path that gets generated, by virtue of the structure of the generated code.

[Shinigami92]

@bcoe So we already want to switch to just cover the src folder instead of the dist/cjs (#432)
Do you think this could already fix it?

[bcoe]

Do you think this could already fix it?

There's a chance. The problem is generally a disconnect between the .ts and the .js, if the typescript compiler introduces an extra logical expression that's not exercised, or the source map remapping has a hiccup, there might be an uncovered element.