Change the method name "toXml" to "writeOutput"

apache / openmeetings

Mirror of Apache Openmeetings

Other

632 stars 257 forks source link

Change the method name "toXml" to "writeOutput" #125

Closed ShangwenWang closed 3 years ago

ShangwenWang commented 3 years ago

Generally speaking, the method outputs data to a Xml file. Nonetheless, we have already known that the output is in XML format through the class name (XmlExport). Therefore, there is no need to mention XML in the method name. On the contrary, "writeOutput" seems clearer since it explictly describes what the method does.

solomax commented 3 years ago

Hello @ShangwenWang,

Thanks for your PR! Unfortunately it can't be merged :(

as it is it will break the build (you change the method name, but not the code calling the method)

According renaming: I'm -0 for it. I do prefer shorter names, and XmlExport.toXml not confusing In case static import will be used the call will be toXml - not confusing at all ...

ShangwenWang commented 3 years ago

OK. Thanks