patronum
patronum copied to clipboard
Change typing in some methods
Description
Checklist for a new method
- [ ] Create a directory for the new method in the
srcdirectory inparam-case - [ ] Place the source code to
src/method-name/index.tsin ESModules export incamelCasenamed export - [ ] Add tests to
src/method-name/method-name.test.ts - [ ] Add fork tests to
src/method-name/method-name.fork.test.ts - [ ] Add type tests to
test-typings/method-name.ts- Use
// @ts-expect-errorto mark expected type error -
import { expectType } from 'tsd'to check expected return type
- Use
- [ ] Add documentation in
src/method-name/readme.md- Add header
Patronum/MethodName - Add section with overloads, if have
- Add
Motivation,Formulae,ArgumentsandReturnsections for each overload - Add useful examples in
Examplesection for each overload
- Add header
- [ ] Fill frontmatter in
src/method-name/readme.md- Add
title. Make sure it uses camelCase syntax just like the method itself - Add
slug. Use param-case to write it. In most cases it will be just liketitle - Add
desriptionwith one short sentence describing what method useful for - Add
group. To categorize method on/operatorspage. Full list of available groups, you can see in documentation/src/content/config.ts
- Add
Converted to draft, due to failing CI