Skip to content

Commit

Permalink
Improve worker module docstring
Browse files Browse the repository at this point in the history
Corrected grammatical error and improved the wording of module docstring in
`make_CHS_currents_file.py` and its associated tests. Ensured consistent use of
terminology by changing "average" to "averages" and specifying "netCDF" instead
of "nc file".
  • Loading branch information
douglatornell committed Sep 2, 2024
1 parent 48ad20e commit d78c51a
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions nowcast/workers/make_CHS_currents_file.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""SalishSeaCast worker that average, unstaggers and rotates the near surface velocities,
and writes them out in an nc file for CHS to use
"""SalishSeaCast worker that averages, unstaggers and rotates the near surface velocities,
and writes them out in a netCDF file for CHS to use.
"""
import logging
import os
Expand Down
2 changes: 1 addition & 1 deletion tests/workers/test_make_CHS_currents_file.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def test_instantiate_worker(self, mock_worker):
worker = make_CHS_currents_file.main()
assert worker.name == "make_CHS_currents_file"
assert worker.description.startswith(
"SalishSeaCast worker that average, unstaggers and rotates the near surface velocities,"
"SalishSeaCast worker that averages, unstaggers and rotates the near surface velocities,"
)

def test_add_run_type_arg(self, mock_worker):
Expand Down

0 comments on commit d78c51a

Please sign in to comment.