Skip to content

Commit

Permalink
clean up comments in get_berror_dict_identity (NOAA-EMC#1313)
Browse files Browse the repository at this point in the history
  • Loading branch information
RussTreadon-NOAA committed Apr 17, 2023
1 parent 850e1b6 commit c6e4564
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions ush/python/pygfs/task/atm_analysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -301,13 +301,18 @@ def get_berror_dict(self, config: Dict[str, Any]) -> Dict[str, List[str]]:
@staticmethod
@logit(logger)
def _get_berror_dict_identity(config: Dict[str, Any]) -> Dict[str, List[str]]:
"""Placeholder for atm identity background error files to copy
This method currently does nothing since the identity background error
does not require any external files.
"""Identity BE does not need any files for staging.
This is a private method and should not be accessed directly.
Parameters
----------
config: Dict
a dictionary containing all of the configuration needed
Returns
----------
berror_dict: Dict
Empty dictionary [identity BE needs not files to stage]
"""
logger.info(f"Identity background error does not use staged files. Return empty dictionary")
return {}
Expand Down

0 comments on commit c6e4564

Please sign in to comment.