search

clojure-emacs / cider

The Clojure Interactive Development Environment that Rocks for Emacs
https://cider.mx
GNU General Public License v3.0
3.52k stars 643 forks source link

Rename private functions in `cider-docstring.el` to have proper prefix #3710

Closed katomuso closed 4 weeks ago

katomuso commented 4 weeks ago

Currently, docstring-specific private functions in cider-docstring.el have a global prefix (such as cider--render-pre, cider--string-rstrip-newlines, cider--fragments-to-s, etc.). What do you think about renaming them to have the proper cider-docstring prefix?

bbatsov commented 4 weeks ago

That doesn't matter much to me. On one hand consistency is good, but on another - long function names impede readability a bit. I keep dreaming of having real namespaces in Elisp.

katomuso commented 4 weeks ago

I understand your concerns, but I think that it can actually improve readability as it becomes obvious that those functions belong to a particular package and serve a specific purpose. Also, as far as I understand, this is really old code (I can't even find how old using git log) and it will be nice to refactor it a bit along with prefixing names properly.

bbatsov commented 4 weeks ago

It's not a big deal to me either way, so feel free to change this.

vemv commented 4 weeks ago

I don't mind a lot about this, however I wouldn't bother with it.

There a lot of better uses of our time - we're not short of bugs, big and small!

We're always happy to receive contributions, but the best ones tend to solve real problems users face.

Those also build a lot of trust for future interactions.