mirror of
https://github.com/selfxyz/self.git
synced 2026-01-09 14:48:06 -05:00
Add docstring reporting script and workflows (#1333)
* Trim docstring coverage snapshots * format all the tings * update lock * Update docstring coverage snapshots (#1521) * docstring fixes * address agent feedback * update lock files * address agent feedback * lock react-native-svg version to prevent pipeline failures * update docstring logic * remove docstring coverage from ci * remove old report, fix cursorignroe rule
This commit is contained in:
14
packages/mobile-sdk-alpha/docs/DOCSTRING_STYLE_GUIDE.md
Normal file
14
packages/mobile-sdk-alpha/docs/DOCSTRING_STYLE_GUIDE.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# Mobile SDK docstring style guide
|
||||
|
||||
All exported APIs from `packages/mobile-sdk-alpha/src` must carry TSDoc-compliant comments so integrators can rely on generated documentation and in-editor hints.
|
||||
|
||||
## Authoring guidelines
|
||||
|
||||
- Start each docstring with a one-line summary that describes the intent of the API in the imperative mood.
|
||||
- Describe complex parameter shapes with `@param` tags and consider linking to shared types with `{@link ...}` when the name alone is ambiguous.
|
||||
- Capture platform nuances (for example, “Android only”) and error semantics in the main description or an `@remarks` block.
|
||||
- Prefer examples that demonstrate the supported developer experience (React Native, Expo, etc.) and keep them short enough to scan quickly.
|
||||
|
||||
## Coverage expectations
|
||||
|
||||
`yarn docstrings:sdk` (or `yarn docstrings` for both app and SDK) surfaces the current coverage numbers in `docs/coverage/*.json`. The reports can be committed to track progress over time. Coverage thresholds are advisory—use the reports to plan follow-up work even when you need to land code without full documentation.
|
||||
@@ -47,10 +47,7 @@ interface PressableViewProps {
|
||||
}
|
||||
|
||||
export interface ViewProps
|
||||
extends Omit<RNViewProps, 'hitSlop'>,
|
||||
SpacingProps,
|
||||
Omit<ViewStyle, keyof SpacingProps>,
|
||||
PressableViewProps {}
|
||||
extends Omit<RNViewProps, 'hitSlop'>, SpacingProps, Omit<ViewStyle, keyof SpacingProps>, PressableViewProps {}
|
||||
|
||||
const sizeTokens: Record<string, number> = {
|
||||
$0: 0,
|
||||
|
||||
Reference in New Issue
Block a user