fury-gl/fury

DOC warnings and other QoL improvements

Open

#940 opened on Oct 12, 2024

View on GitHub
 (10 comments) (0 reactions) (0 assignees)Python (253 forks)auto 404
:beer: Hacktoberfest :beer:good first issuestate: needs PR

Repository metrics

Stars
 (301 stars)
PR merge metrics
 (PR metrics pending)

Description

  • Numpy 2.0 migration bugs are still present on tutorials
  • When developing the library using fury-dev version, the @warn_on_args_to_kwargs() won't get triggered so some warns can go unnoticed.
  • Warns should mention line numbers if possible, for easy debugging.

Contributor guide

Research direction
Identify and fix Numpy 2.0 migration bugs in tutorials, ensure @warn on args to kwargs() works in dev mode, and add line numbers to warnings.
Tech stack
python
Domain
computer graphics
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70