Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename marshall & Marshaller #3045

Closed
ravage84 opened this issue Mar 18, 2014 · 5 comments
Closed

Rename marshall & Marshaller #3045

ravage84 opened this issue Mar 18, 2014 · 5 comments
Labels
Milestone

Comments

@ravage84
Copy link
Member

Blame it to the fact that I'm not an English native speaker but the method name marshalland the class Marshaller do not tell me much.
http://api.cakephp.org/3.0/class-Cake.Database.Type.html#_marshall
http://api.cakephp.org/3.0/class-Cake.ORM.Marshaller.html

First things that come to my mind are either a platinum awarded Rap CD or the military...

Even worse when I try to translate the word "marshall" don't get far as the real verb has only one L:
http://dictionary.reference.com/browse/marshal

A method name should speak for itself and as the CakePHP community is not consisted of English native speakers, I think we should rename those two.

Even @lorenzo wasn't very happy from the beginning with:
#2425 (comment)

Unfortunately I have no "more primitive tongue" alternative right now.
Just stumbled upon it and wanted to bring it up.

@markstory markstory added this to the 3.0.0 milestone Mar 18, 2014
@markstory markstory added the RFC label Mar 18, 2014
@bcrowe
Copy link
Contributor

bcrowe commented Mar 18, 2014

Marshal/ler/ing is pretty status-quo. http://en.wikipedia.org/wiki/Marshalling_(computer_science) You stumble across this terminology in other programming languages / ORMs.

@markstory
Copy link
Member

Bah, the method should be marhsal() not marshall() I'll get that fixed up.

@bcrowe
Copy link
Contributor

bcrowe commented Mar 18, 2014

Oh, unless you were strictly speaking about the marshall() method. Marshaller as a class name makes sense though.

@ADmad
Copy link
Member

ADmad commented Mar 18, 2014

Marshalling was a relatively new term for me too. But it's a pretty standard tech term used in proper context. There's no need for changing it. People can expand their vocabulary 😄 Just fixing the mis-spelling @markstory noticed is enough.

@lorenzo
Copy link
Member

lorenzo commented Mar 18, 2014

You need to go for more advanced features in order to find that term inside the public API, hence the newEntity and patchEntity method names. When going deeper you are usually more open to learning new terms. Closing as @markstory renamed the method to have the correct spelling

@lorenzo lorenzo closed this as completed Mar 18, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants