Skip to content
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

Improve field value parsing by adding NoDecode and ForceDecode annotations #492

Merged
merged 4 commits into from
Dec 9, 2024

Merge branch 'main' into improve-value-parsing

fb0c1e7
Select commit
Loading
Failed to load commit list.
Merged

Improve field value parsing by adding NoDecode and ForceDecode annotations #492

Merge branch 'main' into improve-value-parsing
fb0c1e7
Select commit
Loading
Failed to load commit list.
Hyperlint AI / Hyperlint Style Guide succeeded Dec 9, 2024 in 14s

👏 No style guide issues found.

1 files reviewed, no outstanding issues found.

Details

📄 docs/index.md

LineIssuesTextComment
377(Spelling-error) Did you really mean 'validator'?Existing:
this behavior for a field and parse the value in your own validator, you can annotate the field with
The term 'validator' is a common term in programming and is used correctly in this context. The style guide review process likely flagged it incorrectly as a spelling error. No change is needed.
404(Spelling-error) Did you really mean 'validator'?Existing:
1. The `NoDecode` annotation disables JSON parsing for the `numbers` field. The `decode_numbers` field validator
The term 'validator' is correct in this context as it refers to a common programming concept. The style guide's suggestion to change it is a false positive. No change is needed.
435(Spelling-error) Did you really mean 'config'?Existing:
This will bypass the `enable_decoding` config setting:
The term 'config' is a widely accepted shorthand for 'configuration' in technical contexts, especially when referring to settings or files. Therefore, the suggestion to change it is unnecessary, and the original text should remain unchanged.
466(Spelling-error) Did you really mean 'validator'?Existing:
and we have to provide a custom validator to parse the value.
The term 'validator' is correctly used and spelled in the context of the sentence. The style guide's suggestion is a false positive, so no change is needed.

🪄 About Hyperlint

Hyperlint is your AI-powered copilot for creating high-quality documentation with minimal effort.

Sign up for a free plan at hyperlint.com.