Skip to content

Commit

Permalink
Update docstring to reflect cfg being an input parameter instead of a…
Browse files Browse the repository at this point in the history
… global variable
  • Loading branch information
daviddemeij committed Aug 9, 2023
1 parent fe44d38 commit 64aca40
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions s2p/initialization.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,10 @@ def check_parameters(d):

def build_cfg(cfg, user_cfg):
"""
Populate a dictionary containing the s2p parameters from a user config file.
This dictionary is contained in the global variable 'cfg' of the config
module.
Populate a default cfg dictionary with the s2p parameters from a user config file.
Args:
cfg: default config dictionary
user_cfg: user config dictionary
"""
# check that all the mandatory arguments are defined
Expand Down

0 comments on commit 64aca40

Please sign in to comment.