From 5ccfb10839002ee926b1c623b89ada2a70132df1 Mon Sep 17 00:00:00 2001 From: Florian Kotthoff <74312290+FlorianK13@users.noreply.github.com> Date: Fri, 8 Mar 2024 12:02:06 +0100 Subject: [PATCH] Correct docstring for mkdocs #487 Not related to this feature, but had to be done anyway. --- open_mastr/mastr.py | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/open_mastr/mastr.py b/open_mastr/mastr.py index 329f4adf..acd626b8 100644 --- a/open_mastr/mastr.py +++ b/open_mastr/mastr.py @@ -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 @@ -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: