Skip to content
This repository was archived by the owner on Jun 29, 2023. It is now read-only.

Commit 8155e54

Browse files
committed
small rewording in docs
1 parent 4a6c2ac commit 8155e54

File tree

3 files changed

+9
-23
lines changed

3 files changed

+9
-23
lines changed

doc/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858

5959
# General information about the project.
6060
project = 'python_mvg_api'
61-
copyright = '2016, Adrian'
61+
copyright = '2017, Adrian'
6262
author = 'Adrian'
6363

6464
# The version info for the project you're documenting, acts as replacement for
@@ -68,7 +68,7 @@
6868
# The short X.Y version.
6969
version = '1.1'
7070
# The full version, including alpha/beta/rc tags.
71-
release = '1.1'
71+
release = '1.1.1'
7272

7373
# The language for content autogenerated by Sphinx. Refer to documentation
7474
# for a list of supported languages.

doc/index.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,24 @@ python_mvg_api – Munich Public Transport made simple
1414

1515
Intro
1616
-----
17-
Not too long ago, MVG (aka Münchner Verkehrsgesellschaft) relaunched their `Website <http://mvg.de>`_, which now actually utilizes a JSON api! (I know, crazy, right?) This python module tries to provide super easy, gluten free [1]_ access to most aspects of the mvg api.
17+
Not too long ago, MVG (aka Münchner Verkehrsgesellschaft) relaunched their `Website <http://mvg.de>`_, which now actually utilizes a JSON api! (I know, crazy, right?) This python module tries to provide easy to use access to most aspects of the mvg api[1].
1818

1919

2020
It offers:
2121

22-
* The next departures for any station in the MVV (duh)
22+
* The next departures for any station in the MVV
2323

2424
* This includes S-Bahn and Schienenersatzverkehr
2525

2626
* Listing nearby stations based on geolocation
27-
* Routing from station to station
27+
* Search for Stations and POI
28+
* Routing
29+
* Current warnings about service interruptions
2830

29-
* Routing from anywhere to anywhere (coming soon!)
3031

31-
Take a look at example.py, it shows some basic concepts, or at the rest of the docs, where every aspect is hopefully adequately documented.
32+
Take a look at example.py, it shows some basic concepts, or at the rest of the docs, where everything should be adequately documented.
3233

33-
.. [1] mvg.de uses stuff like an api key (although *they only give it to themselves*) and Unix time in milliseconds (although the last four digits are always 0). Whith this module, you won't have to worry about all that.
34+
.. [1] mvg.de uses stuff like an api key (although *they only give it to themselves*) and has some other quirks.
3435
3536
Module documentation
3637
--------------------

doc/intro.rst

Lines changed: 0 additions & 15 deletions
This file was deleted.

0 commit comments

Comments
 (0)