refactor: use google styleguide for docstrings with napoleon extension

openedx · Feb 3, 2025 · 5923d0c · 5923d0c
1 parent 5abe5e6
commit 5923d0c
Show file tree

Hide file tree

Showing 4 changed files with 303 additions and 185 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -38,6 +38,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
+    'sphinx.ext.napoleon',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/openedx_filters/course_authoring/filters.py b/openedx_filters/course_authoring/filters.py
@@ -30,8 +30,8 @@ def run_filter(cls, url: str, org: str) -> tuple[str, str]:
         Process the inputs using the configured pipeline steps to modify the URL of the page requested by the user.
 
         Arguments:
-            - url (str): the URL of the page to be modified.
-            - org (str): Course org filter used as context data to get LMS configurations.
+            url (str): the URL of the page to be modified.
+            org (str): Course org filter used as context data to get LMS configurations.
 
         Returns:
             tuple[str, str]: