Document (or close) five known validation gaps in DfsuBuilder and DfsuFile
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 48/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Start by reading the five TODO locations in mikecore/DfsuBuilder.py and mikecore/DfsuFile.py, including the layered-file Validate logic and spectral dispatch. For each gap, determine from the surrounding behavior whether it is an intentional limitation or needs a separate issue with a failing case; done means the decision and rationale are recorded, or follow-up issues are opened.
Written by the indexing model from the issue text.
Description
Five TODOs mark gaps that are already handled conservatively — they raise clearly or skip a check rather than producing wrong output. Collecting them so the limits are visible without reading the source; none is a silent bug.
DfsuBuilder.SetZUnit, mikecore/DfsuBuilder.py:201 — # TODO: Fix! above:
if (zUnit != eumUnit.eumUmeter
and zUnit != eumUnit.eumUfeet
and zUnit != eumUnit.eumUUnitUndefined):
raise Exception("Currently only meter and feet unit is supported")
Any other Z unit is rejected outright. Whether more units should be accepted, and what "Fix!" meant, is unrecorded.
mikecore/DfsuFile.py:224 — # TODO Validate data. Data written to a dfsu is not checked for length or type against the item it belongs to; a mismatch surfaces further down rather than at the call.
mikecore/DfsuBuilder.py:310-311 — in the layered-file validation:
# TODO: Need to check that node coordinates are also on top of each other?
# TODO: Need to check that the 2D elements are defined counter-clockwise
Validate checks that layered elements sit on top of each other by connectivity and that layer counts match the sigma-layer count, but does not check coordinates or element orientation. A file violating either passes validation.
mikecore/DfsuBuilder.py:341 — # TODO do we need to check frequency or directions?; spectral file types get no validation beyond the type dispatch itself.
Each is one of: accept as designed and document it, or promote to its own issue with a case that goes wrong. The value here is that the answer is written down somewhere other than a code comment.
- Dominant language
- Python
- Stars
- 5
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from DHI/mikecore-python
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
DHI/mikecore-python#49 ·
-
Difficulty 5/5 Over a week Newbie friendliness 45/100
DHI/mikecore-python#52 ·
-
Remaining TODOs in production code: platform notes, licensing questions, and one likely-stale marker Open
Difficulty 5/5 Over a week Newbie friendliness 30/100
DHI/mikecore-python#51 ·
-
Difficulty 5/5 Over a week Newbie friendliness 45/100
DHI/mikecore-python#48 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
DHI/mikecore-python#47 ·
All issues in DHI/mikecore-python
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
simonw/sqlite-utils#872 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100