Skip to content

Commit 7a5291a

Browse files
committed
doc fixes
1 parent ad4da38 commit 7a5291a

File tree

5 files changed

+5
-11
lines changed

5 files changed

+5
-11
lines changed

docs/docs/api/role_check_result.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
::: pum.RoleCheckResult
1+
::: pum.RoleInventory

docs/mkdocs.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ theme:
99
logo: assets/images/pum.png
1010
favicon: assets/images/favicon.ico
1111
features:
12-
# - navigation.tabs
13-
# - navigation.tabs.sticky
14-
# - navigation.expand
1512
- navigation.indexes
1613
- navigation.top
1714
- navigation.tracking
@@ -112,7 +109,7 @@ nav:
112109
- PermissionType: api/permission_type.md
113110
- PumConfig: api/pum_config.md
114111
- Role: api/role.md
115-
- RoleCheckResult: api/role_check_result.md
112+
- RoleInventory: api/role_check_result.md
116113
- RoleManager: api/role_manager.md
117114
- RoleStatus: api/role_status.md
118115
- SchemaPermissionStatus: api/schema_permission_status.md

pum/hook.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,7 @@ def execute(
5959
This is not committing the transaction and will be handled afterwards.
6060
6161
Args:
62-
connection: The database connection.
63-
sql: The SQL statement to execute or a path to a SQL file..
62+
sql: The SQL statement to execute or a path to a SQL file.
6463
"""
6564
parameters_literals = SqlContent.prepare_parameters(self._parameters)
6665
SqlContent(sql).execute(
@@ -88,9 +87,9 @@ def __init__(
8887
"""Initialize a Hook instance.
8988
9089
Args:
91-
type: The type of the hook (e.g., "pre", "post").
9290
file: The file path of the hook.
9391
code: The SQL code for the hook.
92+
base_path: The base path for resolving relative file paths.
9493
9594
"""
9695
if file and code:

pum/sql_content.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ def format_sql(
338338
return [format_sql(statement, parameters) for statement in sql_code]
339339

340340
@staticmethod
341-
def prepare_parameters(parameters: dict | None):
341+
def prepare_parameters(parameters: dict | None) -> dict:
342342
"""
343343
Prepares a dictionary of parameters for use in SQL queries by converting each value to a psycopg.sql.Literal.
344344

pum/upgrader.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,6 @@ def __init__(
3535
The table is created in the schema defined in the config file if it does not exist.
3636
3737
Args:
38-
connection:
39-
The database connection to use for the upgrade.
4038
config:
4139
The configuration object
4240
max_version:

0 commit comments

Comments
 (0)