Skip to content

Commit

Permalink
add arg documentation to the note_dependencies function
Browse files Browse the repository at this point in the history
  • Loading branch information
lonnen committed May 13, 2022
1 parent ed99f42 commit 9782c53
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion sphinx_js/directives.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,11 @@ class JsDirective(Directive):


def note_dependencies(app, dependencies):
"""Note dependencies of current document."""
"""Note dependencies of current document.
:arg app: Sphinx application object
:arg dependencies: iterable of filename strings relative to root_for_relative_paths
"""
for fn in dependencies:
# Dependencies in the IR are relative to `root_for_relative_paths`, itself
# relative to the configuration directory.
Expand Down

0 comments on commit 9782c53

Please sign in to comment.