search

gregsexton / ob-ipython

org-babel integration with Jupyter for evaluation of (Python by default) code blocks
738 stars 108 forks source link

Please provide Version or Package-Version header #72

Open dfeich opened 8 years ago

dfeich commented 8 years ago

Minor issue: In order to document in examples which version of ob-ipython was used it would be helpful to have a correct version header in the file.

Invoking (pkg-info-version-info 'ob-ipython) results in

Invalid EPL package file: "~/.emacs.d/elpa/ob-ipython-20160424.1305/ob-ipython.el", "Package lacks a \"Version\" or \"Package-Version\" header"

Thanks

gregsexton commented 8 years ago

I don't particularly want to version ob-ipython. It should always remain backwards compatible. Not really sure what documentation you're talking about?

dfeich commented 8 years ago

The version number is just part of the standard attributes that a package should have. https://www.gnu.org/software/emacs/manual/html_node/elisp/Packaging-Basics.html#Packaging-Basics

Without it the pkg-info-version-info function will produce the above error. The docu is my own. I keep a number of org-examples on github and I usually have an initial section in each example that prints out the emacs and org versions used. For the ipython example I also wanted to have the version number printed. This helps at some later point when things break (as they sometimes do) to find out at what point this happened. Also helps others that want to test the examples.

gregsexton commented 8 years ago

Happy to take a PR to fix this.