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

Add Floobits plugin to MELPA #927

Closed
wants to merge 1 commit into from
Closed

Add Floobits plugin to MELPA #927

wants to merge 1 commit into from

Conversation

ggreer
Copy link
Contributor

@ggreer ggreer commented Aug 5, 2013

By user request: Floobits/floobits-emacs#8

@purcell
Copy link
Member

purcell commented Aug 5, 2013

Thanks for this! A few minor issues and suggestions:

  1. Using "_" bundles a bunch of stuff into the package which shouldn't be there, e.g. non-texinfo docs. Using ("_.el" "*.py" "floo") looks like it would be the right choice.
  2. More importantly, you can't slurp someone else's code into your package, so "highlight.el" should be removed, and a Package-Requires: header should be used to declare a dependency on the highlight package.
  3. Similarly, you need to declare a dependency on json. So, specifically, you're looking at adding a ;; Package-Requires: ((json "1.2") (highlight "0")) header
  4. The footer "ends here" comment needs to be on its own line
  5. You should add a Commentary section in the header describing briefly how to use the package once installed (try enabling auto-insert-mode, then creating a new .el file: you'll see what the basic template for a .el file should look like)
  6. Any user-level interactive entry point functions should ideally be marked with a leading ;;;###autoload comment so that users need not explicitly (require 'floobits) in order to use the functionality

@ggreer
Copy link
Contributor Author

ggreer commented Aug 5, 2013

Wow! Thanks for the helpful comments.

I'll let you know when these issues are fixed. It'll probably be later today. (I'm in UTC-7)

@ggreer
Copy link
Contributor Author

ggreer commented Aug 5, 2013

OK, how's it look now?

@purcell
Copy link
Member

purcell commented Aug 5, 2013

Great, merged, thanks.

@purcell purcell closed this Aug 5, 2013
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