@@ -16,19 +16,19 @@ following **requirements**:
16
16
and camel casing, and PEP8 _ compliance (see below).
17
17
* No classes/methods/functions with missing docstrings or commented-out lines.
18
18
You can take a look at the existing code in python-arango for examples.
19
- * The test coverage _ remains at %100. Sometimes you may find yourself having to
20
- write superfluous unit tests to keep this number up. If a piece of code is
21
- trivial and has no need for unittests , use this _ to exclude it from coverage.
19
+ * The test coverage _ remains at %100. You may find yourself having to write
20
+ superfluous unit tests to keep this number up. If a piece of code is trivial
21
+ and has no need for tests , use this _ to exclude it from coverage.
22
22
* No build failures on TravisCI _. The builds automatically trigger on PR
23
23
submissions.
24
24
* Does not break backward-compatibility (unless there is a really good reason).
25
25
* Compatibility with all supported Python versions: 2.7, 3.4, 3.5 and 3.6.
26
26
27
27
.. note ::
28
28
The dev branch is occasionally rebased _, and its commit history may be
29
- overwritten in the process. So before you begin feature work, git fetch or
29
+ overwritten in the process. Before you begin feature work, git fetch or
30
30
pull to ensure that your local branch has not diverged. If you see git
31
- conflicts and want to start from scratch, run this command :
31
+ conflicts and want to start from scratch, run these commands :
32
32
33
33
.. code-block :: bash
34
34
@@ -48,16 +48,16 @@ To ensure PEP8_ compliance, run flake8_:
48
48
~ $ cd python-arango
49
49
~ $ flake8
50
50
51
- You should try to resolve all issues reported. If there is a good reason to
52
- ignore errors from a specific piece of code, visit here _ to see how to exclude
51
+ You must resolve all issues reported. If there is a good reason to ignore
52
+ errors coming from a specific piece of code, visit here _ to see how to exclude
53
53
the lines.
54
54
55
55
Testing
56
56
=======
57
57
58
58
To test your changes, run the integration test suite that comes with
59
59
**python-arango ** on your local machine. The test suite uses pytest _, and is
60
- designed to run against an actual database instance. Please use the latest
60
+ designed to run against an actual ArangoDB instance. Please use the latest
61
61
version of ArangoDB with the following configuration:
62
62
63
63
* **Host **: "localhost"
@@ -101,10 +101,11 @@ machine:
101
101
~ $ git clone https://github.com/joowani/python-arango.git
102
102
~ $ cd python-arango/docs
103
103
~ $ sphinx-build . build
104
- ~ $ # Open the generated file build/index.html in a browser
105
104
105
+ # Open the generated file build/index.html in a browser
106
106
107
- As always, thanks for your contribution!
107
+
108
+ As always, thank you for your contribution!
108
109
109
110
.. _rebased : https://git-scm.com/book/en/v2/Git-Branching-Rebasing
110
111
.. _dev : https://github.com/joowani/python-arango/tree/dev
0 commit comments