Repository navigation
Fix misspellings in option and header descriptions across 17 components - #29550
Dhairya-007 wants to merge 20 commits into
Conversation
Found by running codespell over the generated catalog, which is the text users see in the component pages, the catalog tooling and the DSL javadoc. Each misspelling is fixed where the generator reads it (the @UriParam/@metadata literal or the setter javadoc) and propagated by hand to the component JSON, the camel-catalog copy, the component DSL and the endpoint DSL, rewrapping the DSL javadoc with the generator's algorithm. entrys, everytime, statics, Certficates, registy, cpoy, transfered, "Address ot", "path ot", proccess, $metdata, seperated, retrive, interprete, custum, implementaion, withing and "one ore more", in atom, chatscript, controlbus, crypto, cxfrs, google-mail-stream, hazelcast-seda, jgroups-raft, jira, knative, olingo2, olingo4, robotframework, salesforce, solr, weather and web3j, plus camel-main's autoConfigurationFailFast and useDataType, the controlbus and main docs (mirrored into the catalog docs) and the same words in core javadoc. Left alone on purpose: the retainUncommitedData option name (renaming it would break users), the deliberate "ello Worl" substring example, and "useable", which is an accepted spelling.
gnodet-bot
left a comment
There was a problem hiding this comment.
These fixes only patch the generated copies — the upstream @UriParam / @Metadata source strings are unchanged. A routine mvn generate-sources will revert everything.
Missing source file — atom (idempotentStrategy):
AtomEndpoint.java, line 56 still reads:
+ "The default strategy checks the Atom entrys updated or published date is newer than the previously read entry. "That string is never touched by this PR; the JSON copy was edited directly.
The same pattern applies to the other three components (chatscript, controlbus, crypto): the @UriParam or @Metadata description literal in the actual Java source file must be fixed first; the generated files should then be regenerated (or updated consistently if the project commits them by hand, which requires documenting that convention).
Incomplete — 13 of 17 components missing:
The PR description lists 17 components but the diff covers only 4: atom, chatscript, controlbus, crypto. The other 13 (cxfrs, google-mail-stream, hazelcast-seda, jgroups-raft, jira, knative, olingo2, olingo4, robotframework, salesforce, solr, weather, web3j) plus the camel-main / IOHelper / InternalProcessor / Budget / RemoveHeadersProcessor javadoc changes are entirely absent from the diff.
Suggested correction — entrys → entry's (not entries):
The original sentence was: "checks the Atom entrys updated or published date is newer than the previously read entry."
entrys is a misspelling of the possessive entry's — the strategy checks one entry's date at a time. entries (bare plural) is grammatically weaker; entry's matches both the singular subject and the surrounding context (note the closing phrase "the previously read entry"). Worth fixing correctly at the source.
This review was generated by an AI agent, Hermès on behalf of @gnodet.
davsclaus
left a comment
There was a problem hiding this comment.
Thanks for this. The four spellings that are in the diff are correct ("entries", "every time", "statistics", "Certificates"). But the pushed commit doesn't match the description. It has 12 files, all generated, for 4 of the 17 components, and none of the sources the generator reads:
- No source files changed.
AtomEndpoint.java:56still has "entrys",ChatScriptEndpoint.java:65"everytime",ControlBusEndpoint.java:144"statics", andDigitalSignatureConfiguration.java:302/312/359"Certficates". The build regenerates the JSON and DSL files from these sources, so it will revert every edit here and CI will fail on uncommitted changes. - The crypto fix is also missing from
DigitalSignatureEndpointBuilderFactory(lines 98, 117, 426 and 447 still say "Certficates"), even though the endpoint-levelkeystore/keyStoreParametersentries incrypto.jsonwere changed. - Nothing from the rest of the table is in the PR: cxfrs, google-mail-stream, hazelcast-seda, jgroups-raft, knative, jira, olingo2/4, robotframework, salesforce, solr, weather, web3j and camel-main. The
controlbus-component.adocandmain.adocedits and their catalog copies are missing too, as are the javadoc fixes inInternalProcessor/SharedInternalProcessor/CamelInternalProcessor/SharedCamelInternalProcessor.
It looks like only part of the local commit was pushed. Could you push the full change, with the source edits, and let the build regenerate the copies (mvn install -DskipTests on each touched module, then on catalog/camel-catalog, dsl/camel-componentdsl and dsl/camel-endpointdsl)? Note that #29539 changes the line next to this one in both crypto.json files, so whichever PR merges second will need a rebase and regen.
Reviewed with Claude Code on behalf of davsclaus. This review was generated by an AI agent and may contain inaccuracies; please verify all suggestions before applying.
|
🌟 Thank you for your contribution to the Apache Camel project! 🌟 🐫 Apache Camel Committers, please review the following items:
|
The previous commit edited only the generated copies, so a regen would have reverted them. AtomEndpoint's @UriParam literal is what the generator reads. entry's rather than entries: the strategy compares one entry's updated or published date against the previously read entry, so the possessive singular is what the sentence needs. The generated copies follow.
ChatScriptEndpoint's @UriParam literal for resetChat; the generated copies were already correct in the previous commit.
ControlBusEndpoint.setAction is where the generator takes the action description from. The javadoc paragraph is re-wrapped because the formatter wraps comments at 120 columns and statistics pushed the line to 122. Also the four occurrences in controlbus-component.adoc and its camel-catalog mirror, which were missing before.
The three setter javadocs in DigitalSignatureConfiguration feed the keystore and keyStoreParameters descriptions, and DigitalSignatureEndpointBuilderFactory still had the four generated copies of them.
…er docs The API component plugin copies the Olingo2App/Olingo4App javadoc into the generated endpoint configuration and the component JSON, so the typo reached the catalog from there. Both the read and uread API methods carry the parameter.
autoConfigurationFailFast and useDataType, in both configuration properties classes, plus the generated metadata, its camel-catalog copy and main.adoc with its mirror.
The other places the same words appear. None of these feeds the catalog, so there is nothing generated to regenerate: - everytime -> every time: IOHelper.copy javadoc - statics -> statistics: the InternalProcessor javadoc, and the statisticsEnabled row in stream-caching.adoc - withing -> within: Budget.elapsed javadoc - one ore more -> one or more: RemoveHeadersProcessor, RemovePropertiesProcessor and CamelContextFactoryBean javadoc
|
Thanks both — you were right, only part of the change had been pushed and none of the sources. The full change is in now, 18 commits on top of the original one, one per component plus Sources are fixed first now. Every The missing pieces are all added: the other 13 components, both olingo modules (which were absent entirely), the four remaining On What I checked, since the generated copies are updated by hand:
I could not run the regen locally, so if CI's On the overlap with #29539: it changes the |
gnodet-bot
left a comment
There was a problem hiding this comment.
Previous findings are all addressed. LGTM.
All previous review findings are fully addressed — source Java files are now properly edited for all 17 components (plus core/javadoc fixes), and generated files are consistent with the sources. The entry's possessive fix is correctly applied as suggested. All misspellings are fixed at the annotation/javadoc source level, so a mvn generate-sources regeneration will produce the corrected text, not revert these edits.
This review was generated by an AI agent, Hermès on behalf of @gnodet.
|
davsclaus
left a comment
There was a problem hiding this comment.
Thanks for pushing the full change. All the earlier points are addressed: every typo is now fixed at the source the generator reads (the @UriParam/@Metadata literals, the setter javadoc and the Olingo2App/Olingo4App javadoc), the four remaining "Certficates" in DigitalSignatureEndpointBuilderFactory and the two in CryptoComponentBuilderFactory are fixed, and the missing components, controlbus-component.adoc, main.adoc and the core javadoc are in.
I checked the generated copies statically: each component JSON and the camel-main metadata are identical to their camel-catalog copies, the two .adoc mirrors match, and every changed javadoc block in the component and endpoint DSL factories matches the generator's wrapping. None of the old spellings are left anywhere in the generated or source files (only in test fixtures, which can stay as they are).
Heads-up again: this PR and #29539 both change crypto.json (component and catalog), so whichever merges second needs a rebase and regen.
Claude Code on behalf of davsclaus. This review was generated by an AI agent and may contain inaccuracies; please verify all suggestions before applying.
Running codespell over the generated catalog (the text that ends up on the component pages, in the catalog tooling and in the DSL javadoc) finds 18 real misspellings in option and header descriptions. This PR fixes each one at the source the generator reads (the
@UriParam/@Metadataliteral or the setter javadoc) and propagates it by hand to every generated copy: the component JSON, thecamel-catalogcopy (asserted byte-identical), the component DSL factory and the endpoint DSL factory. The DSL javadoc is re-wrapped withEndpointDslMojo.formatJavadocOrCommentStringAsList's algorithm, verified by first reproducing the existing blocks byte-for-byte, so a regen should produce no diff; if CI's regen disagrees I will take its patch.entrysidempotentStrategyeverytimeresetChat,IOHelperjavadocstatics→ statisticsaction, the controlbus and stream-caching docs,InternalProcessor/CamelInternalProcessorjavadocCertficateskeystore,keyStoreParametersregistyproviderscpoyCamelGoogleMailStreamBccheadertransferedtransferExchangeAddress ot/path otCamelJGroupsRaftLeaderAddressheader, knativeenvironmentPathproccessverificationCode$metdataedmAPI parameter (javadoc ofOlingo2App/Olingo4App, which the API component plugin copies)seperatedmetadataretriverefreshTokeninterpretedeleteByQuerycustum,implementaiongeoLocationProviderwithingpositionoption andCamelWeb3jPositionheader,Budgetjavadocone ore moreautoConfigurationFailFastanduseDataType(both configuration-properties classes, the generated metadata and its catalog copy,main.adoc),RemoveHeadersProcessor/RemovePropertiesProcessor/CamelContextFactoryBeanjavadocThe two edited
.adocfiles (controlbus-component.adoc,main.adoc) are mirrored intocatalog/camel-catalog/.../docs/, which were byte-identical before the change.Left alone on purpose, so this is not a blind codespell run:
retainUncommitedData(azure-storage-datalake) is an option name; renaming it would break users.${substring(1,-1)} -> ello Worlin the simple language is the example's intended output.useableis an accepted spelling.Doc-only change, no behaviour change.