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

Doc strings within 80 char limit for hib-kbd.el #220

Merged
merged 3 commits into from
Aug 1, 2022

Conversation

matsl
Copy link
Collaborator

@matsl matsl commented Jul 20, 2022

What

Doc strings within 80 char limit for hib-kbd.el

Why

Extracted from longer PR for easier review.

@matsl matsl requested a review from rswgnu July 20, 2022 21:58
hib-kbd.el Outdated Show resolved Hide resolved
hib-kbd.el Outdated
@@ -447,12 +458,13 @@ For an approximate inverse of this, see `key-description'."
res)))

(defun kbd-key:extended-command-p (key-series)
"Return non-nil if the string KEY-SERIES is a normalized extended command invocation, i.e. M-x command."
"Return non-nil if the KEY-SERIES is a normalized extended command invocation.
A command of the form M-x command."
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is, 'M-x command'.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI: checkdocs complains: Keycode` M-x embedded in doc string. Use \\<mapvar> & \\[command] instead
Not sure how to apply that so keeping the suggested text for now. Will not cause a warning when byte compiling.

hib-kbd.el Outdated Show resolved Hide resolved
@matsl matsl force-pushed the long_doc_strings_hib-kbd_el branch from 767017b to 55fc350 Compare July 21, 2022 09:41
@matsl matsl merged commit 10970c5 into master Aug 1, 2022
@matsl matsl deleted the long_doc_strings_hib-kbd_el branch August 1, 2022 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants