docs: add JSDoc documentation to core modules #131
commit-lint.yml
on: pull_request
Commit Lint
/
Validate PR commits with commitlint
11s
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
|
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
|