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

Docstring length warnings #79

Open
zach-delong opened this issue Jan 19, 2023 · 1 comment
Open

Docstring length warnings #79

zach-delong opened this issue Jan 19, 2023 · 1 comment
Labels

Comments

@zach-delong
Copy link

The currently published version of helm-org-rifle throws a ton of warnings on startup of my config. Many of these are just warnings that docstrings are longer than 80 characters. Is that something that should be shortened? Is there a downside to just narrowing the existing docstrings? If that's something that bothers other folks as well I'm happy to put together a PR.

This is an example of one of the warnings I see when I fire up my config with only rifle loaded.
Warning (comp): helm-org-rifle.el:1193:8: Warning: docstring wider than 80 characters Disable showing Disable logging

@alphapapa
Copy link
Owner

Hello Zachery,

These are oversights that should be fixed, yes. However, as the warning you showed indicates, this should only happen when the package is being compiled after installation, not on every Emacs startup. If that is happening on every startup, it likely indicates a problem in your Emacs config.

BTW, see also org-ql, which mostly supersedes org-rifle now.

@alphapapa alphapapa added the bug label Jan 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants