Merge pull request #976 from hkad98/jkd/docs

docs: add rule to ruff to check un-documented params

Author: hkad98

gooddata-pandas/gooddata_pandas/data_access.py

@@ -358,7 +358,7 @@ def _extract_from_attributes_and_maybe_metrics(
 
     Args:
         response (ExecutionResponse): The execution response to extract data from.
-        catalog (CatalogWorkspaceContent): The catalog workspace content.
+        attributes (list[CatalogAttribute]): The catalog of attributes.
         cols (list[str]): A list of column names.
         col_to_attr_idx (dict[str, int]): A mapping of pandas column names to attribute dimension indices.
         col_to_metric_idx (dict[str, int]): A mapping of pandas column names to metric dimension indices.

gooddata-sdk/gooddata_sdk/catalog/permission/service.py

@@ -120,7 +120,7 @@ def get_declarative_organization_permissions(self) -> list[CatalogDeclarativeOrg
             None
 
         Returns:
-            [CatalogDeclarativeOrganizationPermission]:
+            list[CatalogDeclarativeOrganizationPermission]:
                 List of all declarative organization permissions.
         """
 
@@ -136,8 +136,8 @@ def put_declarative_organization_permissions(
         """Put a list of all declarative organization permissions.
 
         Args:
-            org_permissions([CatalogDeclarativeOrganizationPermission])
-                list of declarative organization permissions
+            org_permissions (list[CatalogDeclarativeOrganizationPermission]):
+                List of declarative organization permissions.
 
         Returns:
             None

gooddata-sdk/gooddata_sdk/catalog/workspace/service.py

@@ -541,6 +541,7 @@ def generate_localized_workspaces(
             provision_workspace: Should new workspace for the target language be provisioned?
                                         Including setting of corresponding locales.
             store_layouts: Store declarative layouts of all workspaces to disk
+            place_in_hierarchy (bool): Flag if localized workspace should be placed in the hierarchy.
 
         Returns:
             None

pyproject.toml

@@ -21,6 +21,7 @@ lint.select = [
     "SIM",
     "UP",
     "W", # pycodestyle warnings
+    "D417", # undocumented-param
 ]
 lint.ignore = [
     # rules recommended to be ignored when using ruff format
@@ -44,6 +45,8 @@ target-version = "py39"
 [tool.ruff.format]
 exclude = ['(gooddata-api-client|.*\.snapshot\..*)']
 
+[tool.ruff.lint.pydocstyle]
+convention = "google"
 
 [tool.tbump]
 # Uncomment this if your project is hosted on GitHub: