[
https://issues.apache.org/jira/browse/CAMEL-14934?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Claus Ibsen updated CAMEL-14934:
--------------------------------
Fix Version/s: 3.3.0
> Improve Component, Language, Data format, etc. descriptions in Camel Catalog
> ----------------------------------------------------------------------------
>
> Key: CAMEL-14934
> URL: https://issues.apache.org/jira/browse/CAMEL-14934
> Project: Camel
> Issue Type: New Feature
> Reporter: Peter Palaga
> Assignee: Peter Palaga
> Priority: Major
> Fix For: 3.3.0
>
>
> The descriptions of components, languages, data formats, etc. in Camel
> catalog currently use several inconsistent styles. As agreed on camel-dev
> https://www.mail-archive.com/[email protected]/msg50591.html we should try
> to stick to a common style characterized by the following rules:
> (i) Shorter is better. Less/shorter words are faster to read and faster to
> understand
> (ii) An application of (i): Leave out words and information available
> elsewhere in the Catalog record. Esp. do not repeat the title and kind
> (component, language, ...) because they are clear from the context. The same
> holds for the word "Camel".
> (iii) Concentrate on functionality (what it does), because that's what most
> users want to know; preferably start with a verb in the plain (imperative)
> form
> Example:
> old: JacksonXML data format is used for unmarshal a XML payload to POJO or to
> marshal POJO back to XML payload.
> new: Unmarshal an XML payload to POJO or marshal a POJO back to XML.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
