Problem
9 TODO comments scattered across the codebase, some clearly outdated. The most visible one is the @moduledoc on Validation.Writer which literally reads "TODO: proper description" — this shows up on HexDocs.
Inventory
| File |
Line |
TODO |
lib/docspec/core/validation/writer.ex |
2 |
@moduledoc "TODO: proper description" |
lib/docspec/spec/schema.ex |
211 |
"Be more descriptive of what the error is" |
lib/docspec/core/html/writer.ex |
475 |
"Research if we should use CSS" for <ol type> |
lib/docspec/core/docx/reader/convert.ex |
171 |
"detect and convert image captions" |
lib/docspec/core/docx/reader/convert.ex |
210 |
"handle w:r with w:instrText hyperlink field code" |
lib/docspec/core/docx/reader/files/styles.ex |
20 |
"get the style type from the based_on value" |
lib/docspec/core/docx/reader/files/styles.ex |
89 |
"implement looking up paragraph type using basedOn" |
lib/docspec/core/docx/reader/files/styles.ex |
94 |
"implement converting character, numbering and table style types" |
lib/docspec/core/docx/reader/convert/paragraph.ex |
26 |
"move Content to a shared location" |
Proposal
For each TODO:
- Resolve if the fix is straightforward
- Convert to a GitHub issue if it's a real feature/improvement worth tracking
- Remove with a comment if it's a deliberate "won't fix"
Priority: fix the @moduledoc "TODO: proper description" first since it's publicly visible in generated documentation.
Problem
9 TODO comments scattered across the codebase, some clearly outdated. The most visible one is the
@moduledoconValidation.Writerwhich literally reads"TODO: proper description"— this shows up on HexDocs.Inventory
lib/docspec/core/validation/writer.ex@moduledoc "TODO: proper description"lib/docspec/spec/schema.exlib/docspec/core/html/writer.ex<ol type>lib/docspec/core/docx/reader/convert.exlib/docspec/core/docx/reader/convert.exw:rwithw:instrTexthyperlink field code"lib/docspec/core/docx/reader/files/styles.exlib/docspec/core/docx/reader/files/styles.exlib/docspec/core/docx/reader/files/styles.exlib/docspec/core/docx/reader/convert/paragraph.exProposal
For each TODO:
Priority: fix the
@moduledoc "TODO: proper description"first since it's publicly visible in generated documentation.