scipp / scipp/plopp

Document how to use the 3d clipping tool

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

Nobody has claimed this yet.

Dominant language
Python
Stars
12
Forks
6
PR merge metrics
No merged PRs in 30d

Description

The docs on scatter3d are really missing explanations/demo on how to use the clipping tools.
We should add a couple of examples (with screenshots?) on how this is used.

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 with the scatter3d documentation at docs/plotting/scatter3d-plot.html and review the existing clipping-tool content. Add a couple of usage examples, optionally with screenshots, so readers can understand how to use the clipping tools; the documentation should clearly demonstrate their use.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data-visualization, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.