Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Remaining TODOs in production code: platform notes, licensing questions, and one likely-stale marker

オープン
#51 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
30/100
issue の種類
リファクタリング
明瞭さ
説明が足りない
活発さ
活発
技術スタック
python

調査の方向性

まず、mikecore/DfsDLL.py、Projections.py、DfsFile.py、Dfs123File.py、DfsuBuilder.py、MeshFile.py の指定された場所にある TODO を読み、次に関連する issue #46 と既存の Linux テストを確認します。どの注記が古くなっているか、どれにコードまたはドキュメントに関する判断が必要か、未解決の入力およびライセンスに関する問題をどのように決着させるべきかを判断します。完了とは、一覧にあるすべての TODO について、解決方法が文書化されるか、適切なコードまたはドキュメントの変更が行われるか、または不要になったものが削除されている状態です。

索引モデルが issue の本文から書いたものです。

説明

The remaining TODOs in production code are notes to self rather than defects. Listing them so they are visible, and because at least one looks stale enough to just delete.

Platform-conditional behaviour

  • mikecore/DfsDLL.py:56 and mikecore/Projections.py:43 — # TODO: On linux, this looks different! Both sit where a path or library name is resolved. The package does ship and test on Linux, so either the note has been addressed and is stale, or there is a real remaining difference worth naming.

Licensing

  • mikecore/Projections.py:114 and mikecore/Projections.py:329 — # TODO: should this require a license? An open question about whether these projection entry points need a license check. Answering it once, in the docs, is more useful than the question sitting in two places.

Possibly stale

  • mikecore/DfsFile.py:611 — a bare # TODO: implement sitting above four lines that appear to do the work. Most likely a leftover; worth confirming and removing.

Unresolved details

  • mikecore/DfsFile.py:570 and :604 — identical: # TODO: Check which items are loaded and which delete value to store, and if only one, store in DeleteValue
  • mikecore/DfsFile.py:619 — # TODO: Test on dfs3 file from MIKE SHE
  • mikecore/DfsFile.py:923 — # TODO: size of item and hence the values array
  • mikecore/DfsFile.py:988 — # TODO: This assumes time in seconds?
  • mikecore/Dfs123File.py:12 — # TODO: Need to check that this is the same for all items
  • mikecore/DfsuBuilder.py:559 — # TODO unit
  • mikecore/MeshFile.py:167 — # TODO: Make into a enum
  • mikecore/MeshFile.py:323 — # TODO: Throw an exception?

MeshFile.py:323 is the same class of question as #46 — what to do with input that does not match expectations — and could be settled with it.

No code change proposed. The point is that the package currently carries these only in the source, where nobody looking at the issue tracker can see them.

主要言語
Python
スター
5
フォーク
1
平均マージ
1時間 18分
マージ済み PR(30日)
5

環境構築

このプロジェクトの環境構築ファイルはまだ確認していません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

DHI/mikecore-python のほかの issue

DHI/mikecore-python の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。