From edb6e8a60bb0834f11546e47d0093bf3a228b73f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gabriel=20J=2E=20P=C3=A9rez=20Irizarry?= Date: Mon, 7 Oct 2013 13:33:02 -0400 Subject: [PATCH 1/4] Adds documentation for Prelude Python. --- module-docs/prelude-python.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 module-docs/prelude-python.md diff --git a/module-docs/prelude-python.md b/module-docs/prelude-python.md new file mode 100644 index 0000000..5a7eebd --- /dev/null +++ b/module-docs/prelude-python.md @@ -0,0 +1,18 @@ +# Prelude Python Quickstart + +## Python Mode + +Emacs comes with Python programming support through the built-in +Python-mode. Whenever you are editing Python code run `C-h m` to +look at the Python mode key bindings. Alternatively look at the +menu bar entries under Python. To toggle the menu bar press `F12`. + +## Syntax checking + +Prelude ships with [Flycheck](https://github.com/flycheck/flycheck), +an on the fly syntax checker. Flycheck has support for Python two +syntax checkers, [Pylint](http://www.pylint.org/) and +[Flake8](http://flake8.readthedocs.org/en/latest/). In +order to have Flycheck support on the fly syntax checking for +Python you need to have either of these installed and accessible to +Emacs. In order to manually choose a checker run `C-c ! s`. From df88b29d74c6e18b71e7979bf8f013975ccc5fd6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gabriel=20J=2E=20P=C3=A9rez=20Irizarry?= Date: Mon, 7 Oct 2013 13:33:23 -0400 Subject: [PATCH 2/4] Adds search for symbol key-binding to docs. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 93c2cd7..00f8f93 100644 --- a/README.md +++ b/README.md @@ -225,6 +225,7 @@ Keybinding | Description Keybinding | Description -------------------|------------------------------------------------------------ C-c o | Open the currently visited file with an external program. +C-c i | Search for a symbol, only for buffers that contain code C-c g | Search in Google for the thing under point (or an interactive query). C-c G | Search in GitHub for the thing under point (or an interactive query). C-c y | Search in YouTube for the thing under point (or an interactive query). From 0117ffda38e05af350477de497b05de973999c3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gabriel=20J=2E=20P=C3=A9rez=20Irizarry?= Date: Thu, 10 Oct 2013 10:25:19 -0400 Subject: [PATCH 3/4] Move docs, provide link in README. --- README.md | 2 +- modules/doc/README.md | 50 +++++++++++++++++++ .../doc}/prelude-python.md | 0 3 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 modules/doc/README.md rename {module-docs => modules/doc}/prelude-python.md (100%) diff --git a/README.md b/README.md index 00f8f93..c8cf38d 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ there are such). ## Enabling additional modules -By default most of the modules that ship with Prelude are not loaded. +By default most of the modules that ship with Prelude are not loaded. For more information on the functionality provided by these modules visit the [docs](modules/doc/README.md). ```lisp ;;; Uncomment the modules you'd like to use and restart Prelude afterwards diff --git a/modules/doc/README.md b/modules/doc/README.md new file mode 100644 index 0000000..492a8c9 --- /dev/null +++ b/modules/doc/README.md @@ -0,0 +1,50 @@ +# Emacs Prelude Modules + +Prelude provides extra functionality through modules. Some modules may +require extra steps to enable all functionality. These steps and the +functionality provided by these modules are documented on the +following links. + +- C + +- Clojure + +- Coffee + +- Common-Lisp + +- CSS + +- Emacs-Lisp + +- ERC + +- Erlang + +- Haskell + +- JS + +- Latex + +- Lisp + +- Markdown + +- MediaWiki + +- Org + +- Perl + +- [Python](prelude-python.md) + +- Ruby + +- Scala + +- Scheme + +- Scss + +- Web diff --git a/module-docs/prelude-python.md b/modules/doc/prelude-python.md similarity index 100% rename from module-docs/prelude-python.md rename to modules/doc/prelude-python.md From 3231c6bf39378982f24532d78f5096d32980bf4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gabriel=20J=2E=20P=C3=A9rez=20Irizarry?= Date: Thu, 10 Oct 2013 10:29:56 -0400 Subject: [PATCH 4/4] Fix typo, improve styling. --- modules/doc/README.md | 21 --------------------- modules/doc/prelude-python.md | 2 +- 2 files changed, 1 insertion(+), 22 deletions(-) diff --git a/modules/doc/README.md b/modules/doc/README.md index 492a8c9..3ddea00 100644 --- a/modules/doc/README.md +++ b/modules/doc/README.md @@ -6,45 +6,24 @@ functionality provided by these modules are documented on the following links. - C - - Clojure - - Coffee - - Common-Lisp - - CSS - - Emacs-Lisp - - ERC - - Erlang - - Haskell - - JS - - Latex - - Lisp - - Markdown - - MediaWiki - - Org - - Perl - - [Python](prelude-python.md) - - Ruby - - Scala - - Scheme - - Scss - - Web diff --git a/modules/doc/prelude-python.md b/modules/doc/prelude-python.md index 5a7eebd..8de3ff6 100644 --- a/modules/doc/prelude-python.md +++ b/modules/doc/prelude-python.md @@ -10,7 +10,7 @@ menu bar entries under Python. To toggle the menu bar press `F12`. ## Syntax checking Prelude ships with [Flycheck](https://github.com/flycheck/flycheck), -an on the fly syntax checker. Flycheck has support for Python two +an on the fly syntax checker. Flycheck has support for two Python syntax checkers, [Pylint](http://www.pylint.org/) and [Flake8](http://flake8.readthedocs.org/en/latest/). In order to have Flycheck support on the fly syntax checking for