PLT-9008- Fix generated docs warnings #139
Conversation
|
Warning Rate Limit Exceeded@hrajchert has exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 3 minutes and 14 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the @coderabbitai review command. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. WalkthroughThe recent update introduces a new job in the CI pipeline to check documentation generation, refines comments in TypeScript code, and expands the REST client's capabilities by adding new modules and exports. These enhancements include additional configurations, request types, and status entities to support contract and payout functionalities, as well as extending withdrawal capabilities with new endpoint modules. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on X ? TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files ignored due to filter (1)
- package.json
Files selected for processing (5)
- .github/workflows/test-suite.yaml (1 hunks)
- packages/language/core/v1/src/index.ts (1 hunks)
- packages/runtime/client/rest/src/contract/index.ts (3 hunks)
- packages/runtime/client/rest/src/payout/index.ts (1 hunks)
- packages/runtime/client/rest/src/withdrawal/index.ts (1 hunks)
Files skipped from review due to trivial changes (1)
- packages/language/core/v1/src/index.ts
Additional comments: 8
.github/workflows/test-suite.yaml (1)
- 36-38: The new CI job "Check docs generation" is correctly defined and will run the documentation generation command. Ensure that the
npm run docscommand is properly set up to fail the CI job if any warnings are generated.packages/runtime/client/rest/src/contract/index.ts (5)
31-31: The addition of
RoleTokenConfigurationsto the exported entities is correctly implemented.49-49: The addition of
ApplyInputsToContractRequestto the exported entities is correctly implemented.52-57: The addition of several entities related to contract sources and closures is correctly implemented.
61-61: The addition of
TxStatusto the exported entities is correctly implemented.62-62: The addition of
GetNextStepsForContractRequestto the exported entities is correctly implemented.packages/runtime/client/rest/src/payout/index.ts (1)
- 4-5: The export of "collection.js" and "singleton.js" modules is correctly implemented.
packages/runtime/client/rest/src/withdrawal/index.ts (1)
- 3-4: The export of "collection.js" and "singleton.js" modules is correctly implemented.
hrajchert
force-pushed
the
PLT-9008-fix-doc-warnings
branch
from
9d68d8d to
63a3c2c
Compare
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files ignored due to filter (2)
- package.json
- packages/language/examples/typedoc.json
Files selected for processing (8)
- .github/workflows/test-suite.yaml (1 hunks)
- changelog.d/20231219_104332_hrajchert_PLT_9008_fix_doc_warnings.md (1 hunks)
- packages/language/core/v1/src/index.ts (1 hunks)
- packages/language/examples/src/atomicSwap.ts (1 hunks)
- packages/language/examples/src/playground-v1/escrow.ts (1 hunks)
- packages/runtime/client/rest/src/contract/index.ts (3 hunks)
- packages/runtime/client/rest/src/payout/index.ts (1 hunks)
- packages/runtime/client/rest/src/withdrawal/index.ts (1 hunks)
Files skipped from review due to trivial changes (3)
- .github/workflows/test-suite.yaml
- packages/language/core/v1/src/index.ts
- packages/runtime/client/rest/src/payout/index.ts
Files skipped from review as they are similar to previous changes (2)
- packages/runtime/client/rest/src/contract/index.ts
- packages/runtime/client/rest/src/withdrawal/index.ts
Additional comments: 3
changelog.d/20231219_104332_hrajchert_PLT_9008_fix_doc_warnings.md (1)
- 1-3: The changelog entry succinctly captures the essence of the PR, clearly stating the issue addressed and the solution implemented.
packages/language/examples/src/atomicSwap.ts (1)
- 73-74: The export of
IReducealigns with the PR's objective to refine public API exports. However, the initialization ofiReduceasundefinedis unconventional since TypeScript types are design-time constructs and do not exist at runtime. Verify if this is intentional and how it's meant to be used.Verification successful
The search results indicate that
iReduceis used as an input in theatomicSwap.tsfile. Given thatiReduceis initialized asundefined, it seems to be intentionally used to represent avoidinput within the context of this file.Final response:
The
IReducetype has been correctly exported, and theiReduceconstant is used as avoidinput within theatomicSwap.tsfile. This appears to be an intentional use case for representing avoidtype in the codebase.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for usage of `iReduce` to understand its purpose. rg --type typescript "iReduce"Length of output: 65
Script:
#!/bin/bash # Correct the search for usage of `iReduce` by specifying the file extension for TypeScript files. rg "iReduce" -g "*.ts"Length of output: 171
packages/language/examples/src/playground-v1/escrow.ts (1)
- 66-69: The export of
EscrowParamsis consistent with the PR's objective to expand the public API. Ensure that this change is reflected in the documentation ifEscrowParamsis intended for public use.
This PR:
Summary by CodeRabbit
New Features
Documentation
Refactor
Style