Dhairya-007 opened a new pull request, #29642:
URL: https://github.com/apache/camel/pull/29642
Camel's CI has no spell check, so the component documentation pages carry a
number of misspellings. This corrects 17 of them across 13 components, one
commit per component.
### What is corrected
| Component | Fix |
|---|---|
| bindy | `prcoess` → process, `unavaiable` → unavailable, `formater` →
formatter, `optionaly` → optionally |
| coap | `Renegotation` → Renegotiation, `Maxium` → Maximum |
| crypto | `cyphertext` → ciphertext, `suppling` → supplying |
| disruptor | `bouded` → bounded |
| google | `calender` → calendar |
| grok | `plugable` → pluggable |
| hazelcast | `availble` → available |
| jactl | `commends` → comments (the item describes `//` and `/* */`
comments) |
| kafka | `aggregrate` → aggregate |
| paho, paho-mqtt5 | `build-in` → built-in |
| xchange | `commited` → committed |
| zip-deflater | `comressed` → compressed |
### Generated copies
Two of the bindy fixes are inside `// annotation options: START/END` blocks,
which `UpdateReadmeMojo` renders from the Javadoc of the bindy annotations.
The Javadoc on `CsvRecord.allowEmptyStream()` and
`KeyValuePairField.pattern()` is the source of truth, so it is corrected too
and the rendered table rows are updated to match what the build would emit.
Every `components/*/src/main/docs/*.adoc` page is mirrored byte-for-byte into
`catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/`,
so each edit is applied to both copies and the two were checked to be
identical afterwards. `docs/components/modules/ROOT/pages/` holds symlinks to
the component pages, so those follow on their own. `google-summary.adoc` has
no catalog copy.
### Deliberately left alone
- `camel-jt400` `parms` and `camel-soap` `strat` — local variable names in
code examples.
- `camel-shiro` `stirr` — a password string in an example.
- `camel-ubl` `despatch` — "Despatch Advice" is UBL's own document name.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
