doc(annotations): Added and improved tsdoc annotations - #655
Conversation
|
CodeAnt AI is reviewing your PR. Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
codeant-ai
Bot
added
the
size:L
|
CodeAnt AI finished reviewing your PR. |
✅ Object Smoke Tests & Coverage ReportTest Results✅ All smoke tests passed Coverage Results
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests) ✅ All tests passed and all object methods are covered! View detailed coverage reportCoverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%. |
✅ Object Smoke Tests & Coverage ReportTest Results✅ All smoke tests passed Coverage Results
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests) ✅ All tests passed and all object methods are covered! View detailed coverage reportCoverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%. |
✅ Object Smoke Tests & Coverage ReportTest Results✅ All smoke tests passed Coverage Results
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests) ✅ All tests passed and all object methods are covered! View detailed coverage reportCoverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%. |
✅ Object Smoke Tests & Coverage ReportTest Results✅ All smoke tests passed Coverage Results
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests) ✅ All tests passed and all object methods are covered! View detailed coverage reportCoverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%. |
✅ Object Smoke Tests & Coverage ReportTest Results✅ All smoke tests passed Coverage Results
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests) ✅ All tests passed and all object methods are covered! View detailed coverage reportCoverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%. |
✅ Object Smoke Tests & Coverage ReportTest Results✅ All smoke tests passed Coverage Results
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests) ✅ All tests passed and all object methods are covered! View detailed coverage reportCoverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%. |
✅ Object Smoke Tests & Coverage ReportTest Results✅ All smoke tests passed Coverage Results
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests) ✅ All tests passed and all object methods are covered! View detailed coverage reportCoverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%. |
✅ Object Smoke Tests & Coverage ReportTest Results✅ All smoke tests passed Coverage Results
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests) ✅ All tests passed and all object methods are covered! View detailed coverage reportCoverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%. |
✅ Object Smoke Tests & Coverage ReportTest Results✅ All smoke tests passed Coverage Results
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests) ✅ All tests passed and all object methods are covered! View detailed coverage reportCoverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%. |
jrvb-rl
left a comment
jrvb-rl
left a comment
There was a problem hiding this comment.
Some initial comments on the README. Still looking at the rest
|
|
||
| // You can also pass a `fetch` `Response`: | ||
| await client.devboxes.uploadFile('id', { path: 'path', file: await fetch('https://somesite/file') }); | ||
| - **[`runloop.devbox`](https://runloopai.github.io/api-client-ts/stable/classes/DevboxOps.html)** - Devbox management (create, list, execute commands, file operations) |
There was a problem hiding this comment.
Random question: do we have a broken link checker we can run on this? I guess worst case we can run as an after-the-fact thing on the running site
There was a problem hiding this comment.
I'm hoping we don't change these often, but no I'm not aware of it
| ```typescript | ||
| const runloop = new RunloopSDK({ | ||
| bearerToken: process.env.RUNLOOP_API_KEY, | ||
| baseURL: 'https://api.runloop.ai', |
There was a problem hiding this comment.
Do we have public endpoints other than api.runloop.ai? This is useful for us pointing to the dev servers, but is it helpful for other folks?
There was a problem hiding this comment.
this will be for deploy to vpc folks
jrvb-rl
left a comment
jrvb-rl
left a comment
There was a problem hiding this comment.
Very nice! I like the additional examples and overall doc improvements.
| @@ -153,6 +174,8 @@ export class ExecutionResult { | |||
| * Get the stdout output from the execution. If numLines is specified, it will return the last N lines. If numLines is not specified, it will return the entire stdout output. | |||
| * Note after the execution is completed, the stdout is not available anymore. | |||
There was a problem hiding this comment.
Is this true even if I do numLines=N for N < the actual total number of lines? Seems like it would be nice to have an option to retrieve a few lines, then get more if the user decides they need them after looking at the first few. (Could be a TODO for later...)
There was a problem hiding this comment.
Yeah if you ask for 100 and it has 1000 it won't go get more? I think there's room here for another method which is like give me what you have, not sure what to name that method ):
✅ Object Smoke Tests & Coverage ReportTest Results✅ All smoke tests passed Coverage Results
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests) ✅ All tests passed and all object methods are covered! View detailed coverage reportCoverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%. |
|
CodeAnt AI is running Incremental review Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
codeant-ai
Bot
added
size:L
|
CodeAnt AI Incremental review completed. |
|
| Metric | Coverage | Required | Status |
|---|---|---|---|
| Functions | 90.9% | 100% | ❌ |
| Lines | 82.09% | - | ℹ️ |
| Branches | 51.04% | - | ℹ️ |
| Statements | 81.72% | - | ℹ️ |
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests)
View detailed coverage report
Coverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%.
2 participants
CodeAnt-AI Description
Update SDK docs quickstarts and automate Typedoc publishing
What Changed
Impact
✅ Clearer SDK quickstart flow✅ Markdown SDK docs regenerate on main pushes✅ Published docs site reflects latest SDK guidance💡 Usage Guide
Checking Your Pull Request
Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.
Talking to CodeAnt AI
Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:
This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.
Example
Preserve Org Learnings with CodeAnt
You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:
This helps CodeAnt AI learn and adapt to your team's coding style and standards.
Example
Retrigger review
Ask CodeAnt AI to review the PR again, by typing:
Check Your Repository Health
To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.