Add some documentation about how crop is inclusive in terms of array indices

Open
#858 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Read the existing documentation for crop and submap and the linked issue #8276 first. Clarify which pixel-space boundary points crop includes, contrasting that behavior with submap; it is done when the array-index inclusivity rule and contrast are stated unambiguously.

Written by the indexing model from the issue text.

Description

Feature Request
Describe the feature

Following https://github.com/sunpy/sunpy/issues/8276, we should add some defining boundaries in pixel space on which ones are included/not. i.e. the fact that a point on the boundary, it includes that pixel in crop, rather than exclude it, like submap currently does.

Proposed solution

No response

Dominant language
Python
Stars
49
Forks
56
Avg merge
5h 54m
Merged PRs (30d)
9

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.

More from sunpy/ndcube

All issues in sunpy/ndcube

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.