`normalize-docs` silently drops the first of two `--input` files

Open Beginner friendly
#118 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
Half a day
Newbie friendliness
84/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
cli

Research direction

Read the normalize-docs command in main.py and compare its input option with coverage_matrix.py; the issue says main.py currently passes one input. Then add or inspect a command level test for repeated --input values. Done means both paths reach validation and living-doc normalize-docs --input=a --input=b --output=o exits 1.

Written by the indexing model from the issue text.

Description

tech debt
Description of Technical Debt

living-doc-utilities docs/contracts/pipeline-rules.md § One project, one pipeline, one documentation source: two
documentation files in one run fail with MULTIPLE_DOCUMENTATION_SOURCES. coverage-matrix takes --doc-input
more than once for exactly this reason. normalize-docs declares one --input, so click keeps the last, a second
file never reaches validate_inputs, and the command exits 0. The action cannot reach it (main.py passes one input);
a hand-written CLI call can.

Impact of Technical Debt
  • A CLI user loses a documentation file without any error.
Category

Code Quality / Refactoring

Priority

Medium - Should be addressed soon

Proposed Solution

--input takes multiple=True and passes every path to the validation, as coverage_matrix.py does, with a test through the command.

Effort Estimate

Half a day

Dependencies / Related

No response

Additional Context

Measured 2026-11-12 at living-doc-toolkit fea9aa6 (v0.1.0). Re-check:

living-doc normalize-docs --input=a --input=b --output=o exits 1 when fixed.

Dominant language
Python
Stars
0
Forks
0
Avg merge
1d 7h
Merged PRs (30d)
19

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AbsaOSS/living-doc-toolkit

All issues in AbsaOSS/living-doc-toolkit

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.