Remove ambiguous or non-obvious names from API

laike9m / pdir2

Pretty dir() printing with joy:beer:

MIT License

1.32k stars 47 forks source link

Remove ambiguous or non-obvious names from API #9

Closed mjmoore closed 7 years ago

mjmoore commented 7 years ago

.s() could mean many things: Search; splice; sort... etc. It is obvious in a limited API that .s() can probably only mean splice, but why unnecessarily look up the API when the code can speak for itself?

With this, I would refer to the zen of python:

"In the face of ambiguity, refuse the temptation to guess."

laike9m commented 7 years ago

You're right, but I'd rather keep it. People who favor explicitness use search, and those who want to save time use s.