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

describe-function: show arguments before documentation string #3278

Open
3 tasks
odanoburu opened this issue Dec 7, 2023 · 1 comment
Open
3 tasks

describe-function: show arguments before documentation string #3278

odanoburu opened this issue Dec 7, 2023 · 1 comment
Labels
ui/ux Nyxt User Interface: themes, appearance and usability.

Comments

@odanoburu
Copy link
Contributor

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:

  • Discussion has occurred.
  • One or more developers have signed off on this change.
  • One or more user researchers have signed off on this change.
@odanoburu odanoburu added the ui/ux Nyxt User Interface: themes, appearance and usability. label Dec 7, 2023
@aadcg
Copy link
Member

aadcg commented Dec 7, 2023

I think this is a valid point.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ui/ux Nyxt User Interface: themes, appearance and usability.
Development

Successfully merging a pull request may close this issue.

2 participants