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

Prepare code for submission to MELPA #7

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Conversation

timwoj
Copy link
Member

@timwoj timwoj commented Feb 8, 2025

This PR cleans up the code in line with the guidance for submitting new packages to MELPA. This includes:

  • Docs fix-ups based on recommendations from M-x checkdoc
  • Code cleanup based on recommendations from M-x flycheck-compile
  • Lots of cleanup based on the Emacs Lisp style guide

This all follows the MELPA Contributors Guide. Once this gets nerged, I'll open a pull request to MELPA to add it as a package.

@timwoj timwoj requested a review from ckreibich February 8, 2025 20:36
@timwoj timwoj changed the title Prepare code for submission to melpa Prepare code for submission to MELPA Feb 8, 2025
@timwoj timwoj force-pushed the set-up-for-melpa branch from 11c8bb4 to 86a61a5 Compare March 2, 2025 03:19
timwoj added 11 commits March 1, 2025 20:20
We're not requiring c-mode to be loaded, so this variable won't be
defined. We don't want to load all of c-mode just for this one
variable either.
This reverses checking for when before defining the functions to
instead putting the when condition inside the function body. I
grepped around the el files that come with emacs and this appears
to be the standard form.

This also fixes some of the function comments to include the
argument names like they should.
@timwoj timwoj force-pushed the set-up-for-melpa branch from 86a61a5 to 999f1e9 Compare March 2, 2025 03:20
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.

1 participant