Skip to content

Fixed some typos in docs #879

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 29, 2018
Merged

Fixed some typos in docs #879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,4 @@ Contributors:
* nixon (https://github.com/nixon);
* sphaugh (https://github.com/sphaugh);
* tramchamploo (https://github.com/tramchamploo);
* Brad Belyeu (https://github.com/bbelyeu);
4 changes: 2 additions & 2 deletions doc/pymode.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ Pymode has the ability to set code checkers options from pymode variables:
Set PEP8 options *'g:pymode_lint_options_pep8'*
>
let g:pymode_lint_options_pep8 =
\ {'max_line_length': g:pymode_options_max_line_length})
\ {'max_line_length': g:pymode_options_max_line_length}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had tried to copy & paste this line from the help doc into my ftplugin for python files, but was getting syntax errors b/c of the trailing ")"


See https://pep8.readthedocs.org/en/1.4.6/intro.html#configuration for more
info.
Expand All @@ -373,7 +373,7 @@ Set pep257 options *'g:pymode_lint_options_pep257'
Set pylint options *'g:pymode_lint_options_pylint'*
>
let g:pymode_lint_options_pylint =
\ {'max-line-length': g:pymode_options_max_line_length})
\ {'max-line-length': g:pymode_options_max_line_length}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had tried to copy & paste this line from the help doc into my ftplugin for python files, but was getting syntax errors b/c of the trailing ")"


See http://docs.pylint.org/features.html#options for more info.

Expand Down
34 changes: 17 additions & 17 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
- ``:help pymode``
- <https://github.com/python-mode/python-mode/wiki>

**Please use python-mode tag on Stackoverflow to ask questions:**
**Please use python-mode tag on Stackoverflow to ask questions:**
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line and a few others below had unnecessary trailing whitespace on the line.

<https://stackoverflow.com/questions/tagged/python-mode>

-------------------------------------------------------------------------------
Expand All @@ -21,11 +21,11 @@
</p>

***Important***: From 2017-11-19 onwards python-mode uses submodules instead of
hard coding 3rd party libraries into its codebase. Please issue the command:
`git submodule update --init --recursive`
hard coding 3rd party libraries into its codebase. Please issue the command:
`git submodule update --init --recursive`
inside your python-mode folder.

If you are a new user please clone the repos using the recursive flag:
If you are a new user please clone the repos using the recursive flag:
`git clone --recursive https://github.com/python-mode/python-mode`

-------------------------------------------------------------------------------
Expand All @@ -34,21 +34,21 @@ Python-mode is a Vim plugin that magically converts Vim into a Python IDE.

Why Python-mode?

1. **Be more productive**: Pymode saves time by bring all tools necessary for
professional developers so that you can focus on bigger things. It has been
finely tuned based on decades of experience working with Vim and is
constantly kept uptodate.
1. **Be more productive**: Pymode saves time by bringing all the tools
necessary for professional developers so that you can focus on bigger
things. It has been finely tuned based on decades of experience working
with Vim and is constantly kept up to date.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://writingexplained.org/up-to-date-hyphenated

2. **Get smart assistance**: Pymode knows all about your code. We use the
best-in-class intellisense code completion, on-the-fly error checking and
quick-fixes; easy project navigation and much more.
3. **Use the full power and capabilities of Vim**: Unlike traditional IDEs
which can only provide a small subset of Vim functionalities, you can do
everything and anything that you can in Vim.
4. **Modular structure**: We attempt to be create Python-mode in the same
4. **Modular structure**: We attempt to create Python-mode with the same
principles of python: i.e. have a modular structure, so that as and when
better libraries evolve, we can provide you the best experience, while
abstracting the details so that you can get back to what you do best.
5. **Written mostly in Python**: 96.1% written in Python. Well we love Python
5. **Written mostly in Python**: 96.1% written in Python. Well, we love Python
:)

The plugin contains all you need to develop python applications in Vim.
Expand All @@ -70,7 +70,7 @@ The plugin contains all you need to develop python applications in Vim.
* Go to definition (`<C-c>g`)
* And more, more ...

See a screencast here: <http://www.youtube.com/watch?v=67OZNp9Z0CQ>
See a screencast here: <http://www.youtube.com/watch?v=67OZNp9Z0CQ>
Another old presentation here: <http://www.youtube.com/watch?v=YhqsjUUHj6g>

**To read python-mode documentation in Vim, use** `:help pymode`.
Expand Down Expand Up @@ -140,11 +140,11 @@ If your question is not described there then you already know what to do

Nevertheless just a refresher on how to submit bugs:

**(From the FAQ)** Start python mode with:
`vim -i NONE -u <path_to_pymode>/debugvimrc.vim`
**(From the FAQ)** Start python mode with:
`vim -i NONE -u <path_to_pymode>/debugvimrc.vim`
Reproduce the error and submit your python mode debug file. You can check its
location with `:messages` for something like:
`pymode debug msg 1: Starting debug on: 2017-11-18 16:44:13 with file /tmp/pymode_debug_file.txt`.
location with `:messages` for something like:
`pymode debug msg 1: Starting debug on: 2017-11-18 16:44:13 with file /tmp/pymode_debug_file.txt`.
Please submit the entire content of the file along with a reasoning of why the
plugin seems broken.

Expand All @@ -170,7 +170,7 @@ Documentation is available in your vim `:help pymode`.
# Bugtracker

If you have any suggestions, bug reports or annoyances please report them to
the issue tracker at:
the issue tracker at:
<https://github.com/python-mode/python-mode/issues>

# Contributing
Expand All @@ -183,7 +183,7 @@ The contributing guidelines for this plugin are outlined at

Also see the AUTHORS file.

Development of python-mode happens at github:
Development of python-mode happens at github:
<https://github.com/python-mode/python-mode>

Please make a pull request to development branch and add yourself to AUTHORS.
Expand Down