Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
realshouzy committed May 17, 2024
1 parent 4c20b41 commit 617d61e
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,15 @@ To only run a specific test run:
pytest -k test_name_of_the_test
```

##### Annotation

Note that the tests for the network classes may be unstable, because of threading. Therefore they are omitted from `tox` and the [`Test`](/.github/workflows/test.yaml) workflow using `pytest` markers.
To do the same when running `pytest` directly, run:

```bash
pytest -m "not networktest"
```

#### Code linting

The linting and formatting is done using ``pre-commit``, thus run:
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,16 @@ Des weiteren gilt für `QueryResult`, dass die Daten und die Spaltentypen nicht
- MySQL: die entsprechenden Datentypen von MySQL als String
- MSAccess: die entsprechenden Datentypen (Klassen) von Python

### Netzklassen

Die Netzklassen sind ebenfalls semantisch identisch zu den Netzklassen des Landes. Diese sind in [`nrw.network`](/nrw/network/) zu definiert:

- [`Connection`](/nrw/network/_connection.py)
- [`Client`](/nrw/network/_client.py)
- [`Server`](/nrw/network/_server.py)

Die letzteren beiden sind [`ABCs`](https://docs.python.org/3/library/abc.html). Bei diesen weicht die interne Implementation von der Java Implementation des Landes ab, da deren Ansatz nicht eins-zu-eins in Python übertragen werden kann; somit ist der Quellcode für Fortgeschrittene. Nichtsdestotrotz ist die Anwendung und der Funktionsumfang der Selbe wie vom Land.

### Allgemein

Für mehr Information zu einem beliebigen Objekt kann `help` genutzt werden, z.B.:
Expand Down

0 comments on commit 617d61e

Please sign in to comment.