Ferrite-FEM/Ferrite.jl

CellIterator is missing docs for SubDofHandler

Open

#1,202 opened on May 21, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (109 forks)github user discovery
docsgood first issue

Repository metrics

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

Description

The CellIterator docstring is missing information about its behavior when a SubDofHandler is passed into it.

Contributor guide

Research direction
Locate the CellIterator source and add documentation for the SubDofHandler argument, explaining its behavior and usage.
Tech stack
julia
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Julia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85