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.

Sign up for GitHub

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

Jump to bottom

Show function arguments before their documentation string #3282

Closed
wants to merge 1 commit into from
Closed

Show function arguments before their documentation string #3282

wants to merge 1 commit into from

Conversation

odanoburu
Copy link
Contributor

source/describe.lisp: insert arguments before docstring.

Also remove the section and its title (again following Emacs' example). I can add them back if you'd prefer it.

Closes #3278

Checklist:

Everything in this checklist is required for each PR. Please do not approve a PR that does not have all of these items.

  • Git hygiene:
    • I have pulled from master before submitting this PR
    • There are no merge conflicts.
  • I've added the new dependencies as:
    • ASDF dependencies,
    • Git submodules, 
      cd /path/to/nyxt/checkout
git submodule add https://gitlab.common-lisp.net/nyxt/py-configparser _build/py-configparser
    • and Guix dependencies.
  • My code follows the style guidelines for Common Lisp code. See:
  • I have performed a self-review of my own code.
  • My code has been reviewed by at least one peer. (The peer review to approve a PR counts. The reviewer must download and test the code.)
  • Documentation:
    • All my code has docstrings and :documentations written in the aforementioned style. (It's OK to skip the docstring for really trivial parts.)
    • I have updated the existing documentation to match my changes.
    • I have commented my code in hard-to-understand areas.
    • I have updated the changelog.lisp with my changes if it's anything user-facing (new features, important bug fix, compatibility breakage).
      • Changelog update should be a separate commit.
    • I have added a migration.lisp entry for all compatibility-breaking changes.
    • (If this changes something about the features showcased on Nyxt website) I have these changes described in the new/existing article at Nyxt website or will notify one of maintainters to do so.
  • Compilation and tests:
    • My changes generate no new warnings.
    • I have added tests that prove my fix is effective or that my feature works. (If possible.)
    • I ran the tests locally ((asdf:test-system :nyxt) and (asdf:test-system :nyxt/gi-gtk)) and they pass.

@odanoburu
Show function arguments before their documentation string
832e2bd 
source/describe.lisp: insert arguments before docstring.

Also remove the section and its title (again following Emacs' example).
@aadcg
Copy link
Member

aadcg commented Dec 7, 2023

Personally, I don't oppose this change but it's a UI change so @jmercouris and @lansingthomas should decide.

I'd suggest showing it as (function-name <arg-list>).

As of now:

Before

before

After

after

@odanoburu
Copy link
Contributor Author

I'd suggest showing it as (function-name ).

👍

We could put it in the same code element too, so we don't have a blank line between the arguments and the docstring.

@jmercouris
Copy link
Member

I prefer the old way. Actually Thomas and I were talking about overhauling a lot of the appearance of these pages anyways. The font sizes are too different, jarring, among other improvements.

@aadcg
Copy link
Member

aadcg commented Dec 8, 2023

@jmercouris yes, all of these interfaces are in need of an in-depth UI review. I'd like to see it for 4.0, so we still have time.

We could put it in the same code element too, so we don't have a blank line between the arguments and the docstring.

@odanoburu I'd suggest that you take these changes and add them to your config file for the time being. I can help you if you get stuck. When we do review the interfaces we can ask you for advice.

I'd suggest closing this PR then.

@odanoburu
Copy link
Contributor Author

@aadcg Thanks! I can live with it until the overhaul, I like to keep minimal configs.

@odanoburu odanoburu closed this Dec 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

describe-function: show arguments before documentation string
3 participants
@odanoburu @aadcg @jmercouris