Skip to content

Commit

Permalink
Correct docstring for mkdocs #487
Browse files Browse the repository at this point in the history
Not related to this feature, but had to be done anyway.
  • Loading branch information
FlorianK13 committed Mar 8, 2024
1 parent e2f6d3f commit 5ccfb10
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions open_mastr/mastr.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,15 @@ class Mastr:
A SQL database is used to mirror the MaStR database. It can be filled with
data either from the MaStR-bulk download or from the MaStR-API.
!!! example
```python
from open_mastr import Mastr
db = Mastr()
db.download()
```
Parameters
----------
engine : {'sqlite', sqlalchemy.engine.Engine}, optional
Expand All @@ -63,13 +72,8 @@ class Mastr:
Allows connection to an existing translated database. Default is 'False'.
Only for 'sqlite'-type engines.
!!! example
```python
from open_mastr import Mastr
db = Mastr()
db.download()
```
"""

def __init__(self, engine="sqlite", connect_to_translated_db=False) -> None:
Expand Down

0 comments on commit 5ccfb10

Please sign in to comment.