Skip to content

docs: add JSDoc documentation to core modules #134

docs: add JSDoc documentation to core modules

docs: add JSDoc documentation to core modules #134

Triggered via pull request December 10, 2024 08:59
@gosurigosuri
synchronize #110
jsdoc
Status Failure
Total duration 23s
Artifacts

commit-lint.yml

on: pull_request
Commit Lint  /  Validate PR commits with commitlint
14s
Commit Lint / Validate PR commits with commitlint
Fit to window
Zoom out
Zoom in

Annotations

1 error and 1 warning
Commit Lint / Validate PR commits with commitlint
You have commit messages with errors ⧗ input: docs: Add JSDoc comments to network configuration constants - Added detailed JSDoc comments for MAINNET_ID, SANDBOX_ID, TESTNET_ID, USDC_IBC_DENOMS, and AKT_DENOM. - Improved code readability and maintainability by providing type annotations and descriptions for each export. Signed-off-by: Greg Osuri <[email protected]> ✖ body's lines must not be longer than 100 characters [body-max-line-length] ✖ subject must not be sentence-case, start-case, pascal-case, upper-case [subject-case] ✖ found 2 problems, 0 warnings ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint ⧗ input: docs: Add JSDoc comments with examples to CertificateManager exports - Added detailed JSDoc comments to the CertificateManager class export, including usage examples. - Enhanced documentation for the certificateManager instance with clear examples of import and usage. Signed-off-by: Greg Osuri <[email protected]> ✖ body's lines must not be longer than 100 characters [body-max-line-length] ✖ subject must not be sentence-case, start-case, pascal-case, upper-case [subject-case] ✖ found 2 problems, 0 warnings ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint ⧗ input: feat: Add JSDoc comments with examples to ValidationError and SdlValidationError classes - Enhanced the `ValidationError` class with detailed JSDoc comments, including usage examples for the `assert` method. - Updated the `SdlValidationError` class to include comprehensive JSDoc comments and examples, improving code documentation and usability. - Ensured consistency in documentation style across both error classes. Signed-off-by: Greg Osuri <[email protected]> ✖ body's lines must not be longer than 100 characters [body-max-line-length] ✖ subject must not be sentence-case, start-case, pascal-case, upper-case [subject-case] ✖ found 2 problems, 0 warnings ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint ⧗ input: feat: Add JSDoc comments with examples to ValidationError and SdlValidationError classes - Enhanced the `ValidationError` class with detailed JSDoc comments, including usage examples for the `assert` method. - Updated the `SdlValidationError` class to include comprehensive JSDoc comments and examples, improving code documentation and usability. - Ensured consistency in documentation style across both error classes. Signed-off-by: Greg Osuri <[email protected]> ✖ body's lines must not be longer than 100 characters [body-max-line-length] ✖ subject must not be sentence-case, start-case, pascal-case, upper-case [subject-case] ✖ found 2 problems, 0 warnings ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint ⧗ input: docs(types): add JSDoc documentation for network and global types - Add comprehensive JSDoc for network type definitions (MainnetNetworkId, TestnetNetworkId, SandboxNetworkId) - Document Window interface extension for Keplr wallet integration - Include usage examples and parameter descriptions for getOfflineSignerAuto - Improve type definitions readability with detailed descriptions Signed-off-by: Greg Osuri <[email protected]> ✖ body's lines must not be longer than 100 characters [body-max-line-length] ✖ scope must be one of [certificates, network, wallet, api, stargate, sdl, examples] [scope-enum] ✖ found 2 problems, 0 warnings ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint ⧗ input: docs: Enhance SDL class with JSDoc comments and examples - Added detailed JSDoc comments to the `fromString`, `validateGPU`, and `validateStorage` methods in the SDL class. - Included usage examples in the JSDoc to demonstrate practical application of the methods. - Improved code documentation for better readability and understanding. Signed-off-by: Greg Osuri <[email protected]> ✖ body's lines must not be longer than 100 characters [body-max-line-length] ✖ subject must not be sentence-case, start-case, pascal-ca
Commit Lint / Validate PR commits with commitlint
ubuntu-latest pipelines will use ubuntu-24.04 soon. For more details, see https://github.com/actions/runner-images/issues/10636