cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #5948 from bob-smith/spelling_and_typos

Browse source 
Fix various typos in markdown documentation
This commit is contained in:
Michael DeHaan 2014-02-10 20:51:13 -05:00
commit f858679f97
3 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
CODING_GUIDELINES.md
View file

@ -6,7 +6,7 @@ Hi! Thanks for interest in contributing to Ansible.
Here are some guidelines for contributing code. The purpose of this document are to establish what we're looking for in code contributions, and to make sure Here are some guidelines for contributing code. The purpose of this document are to establish what we're looking for in code contributions, and to make sure
new contributions know some of the conventions that we've been using. new contributions know some of the conventions that we've been using.
We don't think much of this should be too strange to readers familar with contributing to Python projects, though it helps if we all get on the same page. We don't think much of this should be too strange to readers familiar with contributing to Python projects, though it helps if we all get on the same page.
Language Language
======== ========
@ -44,7 +44,7 @@ Shebang Lines
============= =============
* /usr/bin/scripts should start with '/usr/bin/env python' * /usr/bin/scripts should start with '/usr/bin/env python'
* module code should still use '/usr/bin/python' as this is replaced automatically by 'ansible_python_interpeter', see the FAQ in the docs for more info. * module code should still use '/usr/bin/python' as this is replaced automatically by 'ansible_python_interpreter', see the FAQ in the docs for more info.
Comments Comments
======== ========
@ -58,7 +58,7 @@ Comments
Classes Classes
======= =======
* With the exception of module code (where inline is better), it is deseriable to see classes in their own files. * With the exception of module code (where inline is better), it is desirable to see classes in their own files.
* Classes should generally not cause side effects as soon as they are instantiated, move meaningful behavior to methods rather than constructors. * Classes should generally not cause side effects as soon as they are instantiated, move meaningful behavior to methods rather than constructors.
Functions and Methods Functions and Methods
@ -262,7 +262,7 @@ To test if something is a string, consider that it may be unicode.
if type(x) == str: if type(x) == str:
# yes # yes
if isintance(x, basestring): if isinstance(x, basestring):
Cleverness Cleverness
========== ==========

2
CONTRIBUTING.md
View file

@ -94,7 +94,7 @@ to see if the issue has already been reported.
When filing a bug, the following information is always required: When filing a bug, the following information is always required:
* A good name for the bug ("Foo module raises exception when xyz=glork is used", vs "foo doesn't work") * A good name for the bug ("Foo module raises exception when xyz=glork is used", vs "foo doesn't work")
* A succint description of the problem * A succinct description of the problem
* What version of ansible you are using (ansible --version) * What version of ansible you are using (ansible --version)
* Steps to reproduce the problem, including commands or playbook snippets as relevant * Steps to reproduce the problem, including commands or playbook snippets as relevant
* Expected results * Expected results

2
packaging/macports/README.md
View file

@ -1,6 +1,6 @@
This portfile installs ansible from the git repository, it will install the This portfile installs ansible from the git repository, it will install the
latest and greatest version of ansible. This portfile does not install the latest and greatest version of ansible. This portfile does not install the
required dependancies to run in fireball mode. required dependencies to run in fireball mode.
## Installing the stable version of ansible via macports ## Installing the stable version of ansible via macports