[jira] [Commented] (CAMEL-17527) Polish the grammar of SyncPropertiesMojo's documentation

["Andrea Cosentino (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/CAMEL-17527?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17479654#comment-17479654 ] 

Andrea Cosentino commented on CAMEL-17527:
------------------------------------------

It makes totally sense. For this kind of task a PR is enough no need for an issue.

> Polish the grammar of SyncPropertiesMojo's documentation
> --------------------------------------------------------
>
>                 Key: CAMEL-17527
>                 URL: https://issues.apache.org/jira/browse/CAMEL-17527
>             Project: Camel
>          Issue Type: Improvement
>          Components: tooling
>            Reporter: skepticoitus interuptus
>            Priority: Minor
>             Fix For: 3.15.0
>
>
> The following command:
> {code:java}
> mvn help:describe -Dplugin=org.apache.camel:sync-properties-maven-plugin -Ddetail{code}
> ...displays the following description of _[the org.apache.camel:sync-properties-maven-plugin|https://bit.ly/syncPropsMojo]_ ({_}emphasis mine{_}):
> {code:java}
>     ...
>     Name: Camel :: Maven Plugins :: Sync Properties
>     Description: Maven plugin to help generating Sync Properties between POMs
>     
>     ...
>     sync-properties:sync-properties  
>     Description: Copy the properties *in* a POM *in* a different POM for syncing purpose.
>     ...{code}
> Consider Camel's _source-to-sink_ metaphor. Think about how that metaphor relates the concepts of "{*}_in_{*}" and "{_}out{_}" to the Camel DSL's "{_}[{*}from{*}()|https://bit.ly/inFrom]{_}" and "[_to()_|https://bit.ly/outTo]" semantics.
> Applying those _source-to-sink_ ("{_}out{_}" and "{*}_in_{*}", "{*}_from_{*}" and "{_}to{_}") semantics to the original description of [_the SyncPropertiesMojo_|https://bit.ly/syncPropsMojo], and substituting the word "{*}_in_{*}" with the word it semantically corresponds to in the _Camel source-to-sink_ metaphor, you would get:
> {quote} 
> _Copy the properties *from* a POM *from* a different POM..._
> {quote}
> Would it not, therefore, be both more grammatically correct ({_}in the English language{_}) and clearer *_semantically_* to instead say:
> {quote}_Copy the properties *from* a POM *to* a different POM..._
> {quote}
>  



--
This message was sent by Atlassian Jira
(v8.20.1#820001)