search

SAP-docs / btp-integration-suite

Markdown source for the Integration Suite documentation. Enables feedback and contributions to improve the documentation.
Creative Commons Attribution 4.0 International
9 stars 13 forks source link

Non-idiomatic use of semicolons in Groovy code samples #3

Closed mwittrock closed 1 year ago

mwittrock commented 1 year ago

https://help.sap.com/docs/SAP_INTEGRATION_SUITE/51ab953548be4459bfe8539ecaeee98d/148851bf8192412cba1f9d2c17f4bd25.html

(This applies to all of this page's subpages that contain Groovy code.)

Ending statements with a semicolon in Groovy is not idiomatic. It is quite literally the first point in the style guide :-) Also, some code examples in these pages use semicolons while others don't, so the usage is not consistent (even within the same piece of code).

I propose that all Groovy code samples omit the semicolons to be in line with the Groovy style guide.

DavidMitreski5 commented 1 year ago

Thank you for your feedback! We’ll look into it and come back to you if we have any questions.

Karunaharan commented 1 year ago

Hi @mwittrock - thanks for the very first feedback for the SAP Integration Suite via the Open Documentation initiative.

Thanks again, for your valuable feedback on Groovy code samples. I have identified the places where the issue is there. The changes that you propose require some additional investigation from our side too. This is something that we will take up and fix in a staggered approach over the next few release cycles.

Regards, Karuna

fippu82 commented 1 year ago

The same could be told about the Groovy code template that is included in every new Groovy script upon creation. But that's not a documentation input so I guess this is the wrong place to discuss this. :-)