atlas-engineer / nyxt

Nyxt - the hacker's browser.
https://nyxt-browser.com/
9.65k stars 404 forks source link

describe-function: show arguments before documentation string #3278

Open odanoburu opened 6 months ago

odanoburu commented 6 months ago

Describe your proposed change:

Show function arguments before their documentation string.

Why do you believe this to be an improvement?

Maybe it's just a personal preference, but I find it better to know what the arguments are before reading about them. This change also makes it easier to find the arguments in case the user knows what the function does, but doesn't remember the exact arguments or their order.

Additional context/User story: I assume the describe interface was inspired by that of Emacs, so I wonder why it deviated from it in this respect. I'm sorry if it was deliberate.


Pre-Build Checklist:

aadcg commented 6 months ago

I think this is a valid point.

Shouldn't be hard, perhaps you could even give it a try!