-
Notifications
You must be signed in to change notification settings - Fork 210
Add docstring reporting script and workflows #1333
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.
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
Merged
transphorm
merged 19 commits into
dev
from
codex/add-docstring-reporting-script-and-workflows
Dec 25, 2025
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
f17c852
Trim docstring coverage snapshots
transphorm 7d2c113
Merge branch 'dev' into codex/add-docstring-reporting-script-and-work…
transphorm 3993c7c
format all the tings
transphorm d3d98bd
Merge branch 'dev' into codex/add-docstring-reporting-script-and-work…
transphorm 9e16b5a
Merge branch 'dev' into codex/add-docstring-reporting-script-and-work…
transphorm f3f4e66
Merge branch 'dev' into codex/add-docstring-reporting-script-and-work…
transphorm 03e5110
update lock
transphorm c9ac7fb
Update docstring coverage snapshots (#1521)
transphorm 86d2faf
docstring fixes
transphorm 98baf30
address agent feedback
transphorm 3706b6d
update lock files
transphorm 361348a
Merge branch 'dev' into codex/add-docstring-reporting-script-and-work…
transphorm 0386644
address agent feedback
transphorm b3a5ed8
Merge branch 'dev' into codex/add-docstring-reporting-script-and-work…
transphorm d75cade
Merge branch 'dev' into codex/add-docstring-reporting-script-and-work…
transphorm 7a1bf99
lock react-native-svg version to prevent pipeline failures
transphorm 4f30da9
update docstring logic
transphorm 98e9405
remove docstring coverage from ci
transphorm 6e4ce9c
remove old report, fix cursorignroe rule
transphorm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # Mobile app docstring style guide | ||
|
|
||
| Docstrings for the React Native app live alongside the source in `app/src`. We follow [TSDoc](https://tsdoc.org) conventions so that typed tooling can generate consistent API documentation. | ||
|
|
||
| ## Authoring guidelines | ||
|
|
||
| - Document every exported component, hook, utility, or type alias with a leading `/** ... */` block written in the imperative mood. | ||
| - Include `@param`, `@returns`, and `@remarks` tags when they improve clarity, especially for side-effects or platform-specific behaviour. | ||
| - Keep examples concise. Prefer inline code blocks for short snippets and use fenced blocks only when you need multiple lines. | ||
| - Mention platform differences explicitly (for example, “iOS only”) so consumers understand the scope of the implementation. | ||
|
|
||
| ## Coverage expectations | ||
|
|
||
| Docstring coverage can be checked locally by running `yarn docstrings:app` (or `yarn docstrings` for both app and SDK). The reports generate JSON snapshots in `docs/coverage/*.json` that can be committed to track progress over time. Coverage targets are not enforced—treat the reports as guardrails to identify documentation gaps. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.