pytroll / pytroll/satpy

Make `_get_sensor_angles` and `_get_sun_angles` public

Open
#2,148 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.2k
Forks
335
Avg merge
1d 18h
Merged PRs (30d)
10

Description

At present, the two functions listed above, which are in modifiers.angles are private (hence the leading _). I frequently use these functions in my own processing chains and I suspect others do too - solar and satellite angles are a commonly used thing.

Can we remove the underscores and make these two functions public? Of course, they're useable as-is but linters tend to complain about accessing private functions. Happy to make a PR for this, but wanted to start with an issue in case there's some reason I've missed that these functions are the way that they are.

Contributor guide

Open the contributing guide

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

Start in the modifiers.angles module and inspect the definitions and any references to _get_sensor_angles and _get_sun_angles. The work is done when both functions have public names without leading underscores and existing checks for the module still pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.