Skip to content

Conversation

riscy
Copy link
Contributor

@riscy riscy commented Oct 8, 2018

Frequent user of this package -- thanks a lot.

Here are a few adjustments I made to the docstrings that might be worth merging. In many cases the appearance of the documentation in M-x apropos is improved, and in the cases where I de-indented comments, the appearance of the documentation in M-x help is improved.

I used https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html and the built-in Emacs syntax checking as guides.

@rust-highfive
Copy link

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @nikomatsakis (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@nikomatsakis
Copy link
Contributor

Seems good =)

@nikomatsakis nikomatsakis merged commit 12cb169 into rust-lang:master Oct 8, 2018
@tromey
Copy link
Contributor

tromey commented Oct 8, 2018

Thanks for doing this. BTW if you don't know you can also try M-x checkdoc. IIRC sometimes it's a bit too pedantic, but occasionally worth checking out.

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.

4 participants