Skip to content

Commit b7ede2a

Browse files
committed
Updates to documentation
1 parent f3743c4 commit b7ede2a

File tree

3 files changed

+12
-7
lines changed

3 files changed

+12
-7
lines changed

docs/developers.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Developers
2-
==========
1+
Contribution Guide
2+
==================
33

44
We welcome contributions to the pyApp project (and sub projects).
55

@@ -16,8 +16,8 @@ met:
1616

1717
- Update the docs with the details if required.
1818

19-
- The API matters, ensure any features provide a nice API for end users.
20-
19+
- The API matters, ensure any features provide a nice API for both developers and
20+
end-users.
2121

2222
The core pyApp package is intended to be light and mainly made up of plumbing
2323
code. If you want to add support for a particular service or server an extension

docs/extensions.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
Extensions
33
##########
44

5+
Extensions are features that are not part of the core pyApp framework but extend
6+
it's functionality.
7+
58

69
Available Extensions
710
====================

docs/getting-started.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Getting Started
55
In this section we will run through the processes of building an application with
66
``pyApp``.
77

8-
App Layout
9-
==========
8+
Application Layout
9+
==================
1010

1111
We'll start with a simple application that accepts input from the command line
1212
and combines it with a value from configuration.
@@ -45,9 +45,11 @@ uses this file to find information for the application.
4545

4646
``__version__``
4747
The version number of the application, it is recommended that this be a
48-
semantic version. ``pyApp`` also provides tools for this to be fetched from
48+
`semantic version`_. ``pyApp`` also provides tools for this to be fetched from
4949
the installed package list.
5050

51+
.. _semantic version: https://semver.org/
52+
5153

5254
``__main__.py``
5355
---------------

0 commit comments

Comments
 (0)