Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

dic freshen up (all files reviewed but python & start)

  • Loading branch information...
commit 4281a637f46b1d63e837ee29f9e6c26c3742c348 1 parent b9afd92
@fdev31 fdev31 authored
View
10 doc/contacts.rst
@@ -6,17 +6,17 @@ Contacts
Snaked has no own site (likely will never have), and development related
tasks go around `github`_ including `issues`_ tracking.
-I understand that not all users have GH account, so will provide additional
-contacts to communicate with me.
+I understand that not all users have GH account, check out the following
+list of alternative ways to contact me:
-* e-mail: bobrov_at_vl.ru or baverman_at_gmail.com. Later I check no so often.
+* e-mail: bobrov_at_vl.ru ( or baverman_at_gmail.com - read with lower priority)
* twitter: `@a_bobrov`_.
-* `blog`_.
+* `blog`_.
I need feedback from other Snaked's users, feel free to post any bugs,
-suggestions or ideas. I have some free time and can reply and implement
+suggestions or ideas. I have some free time allowing me to reply and implement
features fast enough.
.. _blog: http://bobrochel.blogspot.com/
View
29 doc/index.rst
@@ -2,38 +2,39 @@ Snaked user manual
====================
`Snaked`_ (**snak**\ e **ed**\ itor) is light and :ref:`minimalist <minimalist-mean>`
-editor inspired by `Scribes`_, indented mostly for python developers, but
-other users may find it useful too.
+editor inspired by `Scribes`_, mainly targeting python developers, it's
+generic enough to please other kind of users too.
Features:
* Light UI. There are no menu, tool bar, status bar or project browser at all.
- Only editor view itself.
+ Only lasts the editor view itself.
* `gtksourceview2`_ based.
* Keyboard oriented control.
-* Auto projects. In most cases you do not need such boring operation like
- :menuselection:`File --> New project`. Just start edit your file.
+* Automatic projects. In most cases you do not need such boring operation like
+ :menuselection:`File --> New project`.
+ With `Snaked`_ you just start editing your file!
-* Project navigation via Quick Open dialog.
+* Project navigation via ``Quick Open dialog``.
-* Sessions to store last opened editors.
+* Sessions - restore the last state (or any explicit session).
-* Restoring last edit position.
+* The current position is also stored of each edited file.
-* Python auto complete and navigation via rope with very flexible type hinting
- framework. PyGtk, Django support.
+* Python auto completion and navigation via rope with very flexible type hinting
+ framework. Plus an advanced support for PyGtk and Django.
-* Basic python code lint via pyflakes.
+* Basic python code hints via pyflakes.
-* Snippets.
+* Snippets (macro-like code expansion for common coding patterns).
* Unittests (with `py.test <http://pytest.org/>`_ as backend, so there is
- support for usual UnitTest cases, nose cases and ``py.test`` itself).
+ support for usual UnitTest cases, nose cases and ``py.test`` itself).
-* Spell check.
+* Multilingual Spell checking.
.. image:: /images/snaked.*
View
8 doc/install.rst
@@ -17,7 +17,7 @@ Dependencies
From PYPI
---------
-I'm regularly upload packages of new versions. So you can install Snaked with
+I'm regularly uploading new versions. So you can install Snaked with
``easy_install``::
sudo easy_install snaked
@@ -44,16 +44,16 @@ From source
python setup.py build
sudo python setup.py install
-If you often pull changes from master brunch I recommend you following recipe:
+If you often pull changes from master branch I recommend you the following recipe:
* First install snaked in develop mode (remove any snaked dirs in site-packages
before that)::
sudo python setup.py develop
-* Then, if you want use latest snaked from master branch simply do::
+* Then, if you want use latest snaked version (from "master" branch) simply
+ go the the closed snaked directory and type::
- cd cloned/snaked/dir
git pull
View
71 doc/intro.rst
@@ -2,15 +2,15 @@ About Snaked
============
`Snaked`_ (**snak**\ e **ed**\ itor) is light and minimalist editor inspired by
-`Scribes`_, indented mostly for python developers, but other users may find it
-useful too.
+`Scribes`_, mainly targeting python developers, it's
+generic enough to please other kind of users too.
Motivation
----------
-Why I start this project? I was need a good python editor for a long time, tried
-many IDEs but nothing fits my requests: fast, quick project navigation, flexible
+Why did I start this project? I was looking for a good python editor for a long time, tried
+many IDEs but nothing fit my needs: fast, quick project navigation, flexible
code assist tuning, easy to extend.
* `PyDev`_. Almost ideal solution. But very hard to extend.
@@ -18,38 +18,38 @@ code assist tuning, easy to extend.
* `Netbeans`_. It's only a toy. Poor editing capabilities. Very poor auto
completion.
-* `PyCharm`_. Only one project for instance. I too often edit modules from
+* `PyCharm`_. Single project edition only. Too bad, I too often edit modules from
several projects simultaneously.
* Vim + `ropevim`_. May be this is funny, but it is very slow, especially on my
- netbook with syntax highlight and bracket matching enabled. Also hard to
+ netbook with syntax highlight and bracket matching enabled. It's also hard to
extend. However, I love vim, really, it's editing experience is cool and I use
it for all my non coding tasks.
-* Emacs + `ropemacs`_. It is new environment completely. Too much time to learn.
+* Emacs + `ropemacs`_. It is completely new environment to me. Will take too long to learn.
-* `WingIDE`_. Auto complete is very good. Other features are terribly
+* `WingIDE`_. Very good auto completion. Other features are terribly
implemented.
Some words about `Scribes`_. This editor impress me. It shows how one have to
-design editors (from UI point). Moreover, I started to develop plugins for my
-needs. For extending I could use my existing PyGtk experience. It seemed dream
-come true, but few reasons force me to start hack Snaked.
+design editors (from UI point of view). Moreover, I started to develop plugins fitting my
+needs. For extending I could use my existing PyGtk experience. It's like my dream
+come true, but few reasons forced me to start hacking Snaked.
-* Scribes internal architecture. Many little classes with spread out behavior
- responsibility. Message passing based on GObject signals leads to very long
- path to investigate how some features are implemented.
+* Scribes internal architecture. Many little classes with spread out behaviour
+ responsibility. Message passing is based on GObject signals, that's a pain
+ when you try to figure out how some features are implemented.
-* Overall code style. Ignoring PEP8. Groundless using of private attributes. A
- little whitespace in code. Scribes sources are hard to read. Pointless gtk
- main loop invocation. Manual object destruction. Too much boilerplate code,
- tons of copypasting.
+* Overall code style. Ignoring :pep:`8`. Groundless using of private attributes. Almost
+ no white spaces in the code. Scribes sources are hard to read. The gtk
+ main loop invocation is pointless. Objects are manually destroyed. There is
+ too much boilerplate code and tons of copy/pasting.
-* Strange author's opinion about plugins and it's dependencies distribution.
+* Strange author's opinion about plugins and their dependencies distribution.
-And after some thoughts about estimated lines count in own light gtksourceview
-wrapper, I decide to write Snaked.
+After estimating the line count of a light gtksourceview
+wrapper of my own, I decided to write Snaked.
Goals
@@ -57,21 +57,22 @@ Goals
* As little code base as possible. GtkSourceView gives enough features. Editor
core should only implement `editor` and `project` abstractions, provide
- `plugin system` and preferences dialogs for editor settings, shortcut
- configuration and for choosing active plugins from available extensions.
+ `plugin system`.
+ Preferences dialogs implemented for editor settings, shortcut
+ configuration and to choose active plugins from available extensions list.
-* Clean and maintainable code design.
+* Clean and maintainable code and design.
-* Tabs! I'm using awesome tiling wm, so Scribes lacking of tabs is not a problem
- for me. But many users complain about it.
+* Tabs! I'm using awesome tiling wm, so Scribes lack of tabs is not a problem
+ for me. But most users complain about it.
-* Speed. All development will be made on Atom Netbook. Scribes is too slow on
+* Speed. All development will be made on some Atom Netbook. Scribes is too slow on
this hardware.
-* Memory footprint. Scribes internals is too complicated to trace all object
+* Memory footprint. Scribes internals are too complicated to trace because of "spaghetti" object
references and editor leaks like bloody shit. Weakrefs will save the world.
-* Flexible plugin system based on standard python packaging practices.
+* Flexible plug-in system based on standard python packaging methods.
.. _minimalist-mean:
@@ -83,16 +84,16 @@ First of all it is an absence of user interface noise. During file edit you only
need to see text view. Toolbar, menubar, statusbar or project browser are
useless. Hence main Snaked principle -- you see what you need to see.
-In the second you do not need a feature which provided by other tool. For
-example project browser (to look at project structure or to do file operations)
+In the second hand you don't need some feature already provided by another tool. For
+example, a project browser (to look at project's structure or to do file operations)
will never be implemented, because File Managers are intended for such tasks.
-And third minor claim: there are no any widgets designed for controlling with
-mouse. For example tab close buttons, toolbars and so on.
+And third minor claim: there are no widgets designed for mouse-only control.
+For example tab close buttons, toolbars and so on.
However, `minimalist` doesn't mean feature poor. I have a bunch of ideas
-increasing developer productivity which are waiting to be implemented. If you
-also have suggestions I'll listen them with pleasure.
+increasing developer's productivity which are waiting to be implemented. If you
+also have suggestions I'll be glad to listen to them.
.. _snaked: http://github.com/baverman/snaked
View
67 doc/plugins.rst
@@ -19,17 +19,17 @@ Edit and Select
Provides features for easy text editing.
-* ``<ctrl>d`` deletes line under cursor with copying it into clipboard.
+* ``<ctrl>d`` deletes the line under the cursor, copying it into the clipboard.
* ``<ctrl><alt>o`` shows cursor offset and cursor column position.
- Huh? Simply I need offset when write tests (parsing, code analyzing, etc.).
+ Huh? I simply need some offsets (column and line) when I'm writing tests (text parsing, code analyzing, etc.).
-* ``<alt>w`` smart select. Selects semantic blocks. Just try it. Have you ever
- need to select whole function definition or string in quotes or function
- parameters or function call with parameters or statement block? There is only
+* ``<alt>w`` smart select. Selects semantic blocks. Just try it. I'm sure you
+ regularly want to select a whole function definition or a quoted string or function
+ parameters or function call with parameters or any statement block? There is only
one function for such tasks in Snaked. In conjunction with stock
- gtksourceview2 selection moving (``<alt>Up``, ``<alt>Down``) it allows forget
- about copy-paste.
+ gtksourceview2 selection moving (``<alt>Up``, ``<alt>Down``) you will quickly forget
+ about copy-and-paste.
* ``<shift><alt>w`` shrinks smart selection back.
@@ -56,46 +56,48 @@ That's all for now. Planed feature functionality:
Goto Dir
--------
-Default shortcut ``<crtl><alt>l`` opens editor file directory in file manager.
+Default shortcut ``<crtl><alt>l`` opens the folder containing the current document in your file manager.
Goto Line
---------
-``<ctrl>l`` popups dialog with line number input.
+``<ctrl>l`` popups a dialog allowing you to jump to the specified line number.
Hash Comment
------------
-Comments and uncomments code with hashes. Useful for languages with appropriate
-comment symbols. Default key ``<ctrl>slash``.
+Toggle hash ``#`` commenting. Only useful for languages allowing that kind of comments
+Default key ``<ctrl>slash``.
Python Flakes
-------------
Background python code linter. Highlights problems like unused or undefined
-imports or variables. Also gives feedback about syntax errors. Quite handy
-plugin.
+imports or variables. Also gives some feedback about syntax errors.
+This is a time saver plugin.
Save positions
--------------
-Remembers current file position on editor close and restores it on open.
+Remembers latest position in file for the next time.
Search
------
-Simply search, like in other editors.
+Simple search (and replace), like other editors do.
.. image:: /images/search.*
-Replace entry supports back references (``\1`` or ``\g<name>``) for regular
-expression groups in search field.
+When ``Regex`` is on, replace entry supports back references:
+
+* ``\1`` for the first group
+``\g<name>`` for ``name`` group
Shortcuts
*********
@@ -104,14 +106,14 @@ Shortcuts
* ``Escape`` hides it.
-* ``Enter`` in search or replace text entry do actual searching.
+* ``Enter`` in search or replace text entry will initiate the search.
-* ``<ctrl>j``, ``<ctrl>k`` navigate to next/previous match.
+* ``<ctrl>j``, ``<ctrl>k`` jumps to next/previous match.
* ``<ctrl>h`` highlights selection occurrences.
To control `ignore case`, `regex` checkboxes and activate `Replace`/`Replace
-all` buttons you can use mnemonics: ``<alt>c``, ``<alt>x``, ``<alt>p`` and
+all` buttons you can use the following mnemonics: ``<alt>c``, ``<alt>x``, ``<alt>p`` and
``<alt>a``.
@@ -120,17 +122,17 @@ all` buttons you can use mnemonics: ``<alt>c``, ``<alt>x``, ``<alt>p`` and
External tools
--------------
-Plugin allows to run commands optionally piping selection or whole buffer's
-content to it and process it's stdout.
+Plugin allowing to run commands, optionally piping selection or whole buffer's
+content. stdout processing is also supported (for instance, you can get the external program output back into your buffer).
.. image:: /images/external-tools.*
* ``Name``: tool's name. You can use underscore ("_") to define mnemonic key and
- pango markup.
+ pango markup too.
-* ``Langs``: comma separated list of languages for which this tool is intended.
- Leave field empty if tool should be available in all editors.
+* ``Langs``: comma separated list of languages compatibles with this tool.
+ Leave the field empty if the tool should be available on all editors.
* ``Command``: Shell command to execute. Following variables are supported:
@@ -138,22 +140,23 @@ content to it and process it's stdout.
* ``%d`` — current filename's directory
* ``%p`` — current project directory
- Take note, you have not to quote it.
+ .. note::
+
+ You don't have to quote it!
* ``Stdin`` and ``Stdout`` should be self-explanatory.
-Default key to activate run menu is ``<alt>x``. Actual tool can be run by
-pressing it's mnemonic key or selecting it with cursor keys an hitting
-``Enter``.
+The default key to activate the "run" menu is ``<alt>x``. Then, the specific tool can be selected by
+pressing it's mnemonic key or by moving into the list and pressing ``Enter``.
Snippets
--------
-It is similar to vim's SnipMate plugin which are clone of TextMate's snippets,
+It is similar to vim's SnipMate plugin which is a clone of TextMate's snippets,
you may refer to these projects for syntax documentation.
-User snippet files are searched in ``~/.config/snaked/snippets``. You can
+User snippet files are read from ``~/.config/snaked/snippets``. You can
configure it via preferences (``<ctrl>p``) item ``Snippets``.
There is ability to attach several snippet sets to one editor via multiple
@@ -170,4 +173,4 @@ Spell check
Attaches spell checker to current editor. You need ``pygtkspell`` installed
(look at gnome-python-extras package for your distro).
-Spell check is activated/deactivated by ``F7`` key.
+Spell check is activated/deactivated by pressing ``F7`` key.
Please sign in to comment.
Something went wrong with that request. Please try again.