Skip to content

Commit c3b3e76

Browse files
committed
Mostly line wraps, and a small grammar fix to writing/documentation.
1 parent 2e9ae21 commit c3b3e76

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/writing/documentation.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,21 @@ both you and others a lot of time.
88
Project Documentation
99
---------------------
1010

11-
A :file:`README` file at the root directory should give general
12-
information to the users and the maintainers. It should be raw text or
13-
written in some very easy to read markup, such as
14-
:ref:`reStructuredText-ref` and Markdown. It should contain a few
15-
lines explaining the purpose of the project or the library (without
16-
assuming the user knows anything about the project), the url of the
17-
main source for the software, and some basic credit information. This
18-
file is the main entry point for readers of the code.
11+
A :file:`README` file at the root directory should give general information
12+
to both users and maintainers of a project. It should be raw text or
13+
written in some very easy to read markup, such as :ref:`reStructuredText-ref`
14+
or Markdown. It should contain a few lines explaining the purpose of the
15+
project or library (without assuming the user knows anything about the
16+
project), the url of the main source for the software, and some basic credit
17+
information. This file is the main entry point for readers of the code.
1918

2019
An :file:`INSTALL` file is less necessary with Python. The installation
2120
instructions are often reduced to one command, such as ``pip install
2221
module`` or ``python setup.py install`` and added to the :file:`README`
2322
file.
2423

25-
A :file:`LICENSE` file should *always* be present and specify the license under which the
26-
software is made available to the public.
24+
A :file:`LICENSE` file should *always* be present and specify the license
25+
under which the software is made available to the public.
2726

2827
A :file:`TODO` file or a ``TODO`` section in :file:`README` should list the
2928
planned development for the code.
@@ -158,7 +157,8 @@ Pycco_
158157
.. _Docco: http://jashkenas.github.com/docco
159158

160159
Ronn_
161-
Ronn builds unix manuals. It converts human readable textfiles to roff for terminal display, and also to HTML for the web.
160+
Ronn builds unix manuals. It converts human readable textfiles to roff
161+
for terminal display, and also to HTML for the web.
162162

163163
.. _Ronn: https://github.com/rtomayko/ronn
164164

0 commit comments

Comments
 (0)