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

silence docstring warnings during byte-compilation #2964

Closed
wants to merge 1 commit into from

Conversation

jmay
Copy link

@jmay jmay commented Mar 30, 2022

emacs 28 is aggressive about byte-compiling everything.
Hydra docstrings violate the mandated 80-char docstring limit.
Use a local variable to get it to shut up for ivy-hydra.el.

emacs 28 is aggressive about byte-compiling everything.
Hydra docstrings violate the mandated 80-char docstring limit.
Use a local variable to get it to shut up for ivy-hydra.el.
@basil-conto
Copy link
Collaborator

Thanks! I would have merged this, but it's actually possible to change ivy-hydra.el in such a way that overly wide docstrings are not generated to begin with (at least for now), so I've gone with that approach instead.

Specifically, what was making the docstrings overly wide was certain hydra heads that were defined in terms of a sexp that is later placed in an interactive lambda and finally printed verbatim in the docstring. Placing these sexps in a named command instead allows the auto-generated hydra docstring to remain narrower.

@basil-conto basil-conto added enhancement doc Related to documentation labels Apr 2, 2022
@jmay
Copy link
Author

jmay commented Apr 3, 2022

Awesome. This approach is much better.

@jmay jmay deleted the refac-docstrings branch April 3, 2022 02:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Related to documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants