-
Notifications
You must be signed in to change notification settings - Fork 175
style(jmespath): apply stricter linting & improve docstrings #4568
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR applies stricter linting rules and improves documentation formatting for the jmespath package. The main changes focus on standardizing docstring parameter notation and addressing various linting issues.
- Updated all docstring parameter notation from
@param name Description
to@param name - Description
- Fixed linting issues including forEach to for...of conversion, parseInt radix specification, and comment formatting
- Enhanced documentation with missing docstrings and improved formatting consistency
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 5 comments.
Show a summary per file
File | Description |
---|---|
packages/jmespath/src/utils.ts | Updated docstrings and converted forEach to for...of loop |
packages/jmespath/src/types.ts | Standardized docstring parameter notation |
packages/jmespath/src/search.ts | Updated docstring parameter formatting |
packages/jmespath/src/errors.ts | Fixed docstring formatting and added missing documentation |
packages/jmespath/src/envelopes.ts | Standardized docstring parameter notation |
packages/jmespath/src/constants.ts | Added spacing between constant declarations |
packages/jmespath/src/ast.ts | Updated all docstring parameter formatting |
packages/jmespath/src/TreeInterpreter.ts | Updated comment formatting and ts-ignore to ts-expect-error |
packages/jmespath/src/PowertoolsFunctions.ts | Fixed imports and updated link references in docstrings |
packages/jmespath/src/Parser.ts | Updated docstrings and added missing documentation |
packages/jmespath/src/ParsedResult.ts | Standardized docstring parameter notation |
packages/jmespath/src/Lexer.ts | Added radix parameter to parseInt calls |
packages/jmespath/src/Functions.ts | Updated all docstring parameter formatting |
packages/jmespath/src/Expression.ts | Standardized docstring parameter notation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Only one small comment from me, although it looks like the Co-pilot ones are all valid too. |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
@svozza wait what's your comment? I don't think it got published. |
Ah sorry, yeah, forgot to hit submit! |
|
Summary
This PR resolves all the linting issues resulting from the new rules being introduced in #4545.
While working on this, I also updated the dosctrings to use the standard notation of
@param name - description
.Important
This PR is expected to have failing CI, focus only on the CI steps for this package (
jmespath
). It's safe to merge since it's not going onmain
but onci/fix_linting
.Issue number: closes #4553
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.