Skip to content

Commit

Permalink
Docstring for create_frontend_args
Browse files Browse the repository at this point in the history
  • Loading branch information
reuterbal committed Mar 4, 2024
1 parent 04d2d50 commit 31c6eec
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions loki/bulk/configure.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,22 @@ def create_frontend_args(self, path, default_args):
The resulting `dict` contains overwrites that have been provided
in the :attr:`frontend_args` of the config.
Parameters
----------
path : str or pathlib.Path
The file path for which to create the frontend arguments. This
can be a fully-qualified path or include :any:`fnmatch`-compatible
patterns.
default_args : dict
The default options to use. Only keys that are explicitly overriden
for the file in the scheduler config are updated.
Returns
-------
dict
The frontend arguments, with file-specific overrides of
:data:`default_args` if specified in the Scheduler config.
"""
path = str(path).lower()
frontend_args = default_args.copy()
Expand Down

0 comments on commit 31c6eec

Please sign in to comment.