openradar / openradar/PyDDA

get_dd_wind_field technique name potentially confusing for non-native English speakers

Open
#37 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

foreign-language
Dominant language
Jupyter Notebook
Stars
112
Forks
49
Avg merge
12h 52m
Merged PRs (30d)
2

Description

@ocepaf noted in his review of the PyDDA conference proceedings for SciPy that the current name of get_dd_wind_field could be confusing to non-native English speakers and suggested calculate or compute instead of get for the first word. I am open to suggestions here but am siding on using "compute."

This fits into PyDDA's roadmap of making it more accessible to non-English speakers, so it's a good addition to add.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the PyDDA source for get_dd_wind_field and inspect its definition and all references. Confirm whether compute is the chosen replacement, then update the function name and its references consistently; the issue does not name a file or test to run.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend-api-design
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.