sillsdev / sillsdev/ptx2pdf

Suggestion: warn about invalid piclist anchor ref

Open
#773 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
33
Forks
15
PR merge metrics
No merged PRs in 30d

Description

The piclist reading code reads 3 items, separated by a space: [Book] [Reference] [Rest of the line]
If the user forgets to put a space after the book, PTXprint can end up writing a line that is interpreted as:
[BookReference] [Rest] [of the line]

Leaving the user scratching their heads about why things aren't working properly.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by locating the piclist reading code described in the issue and reproduce input where the book and reference are not separated by a space. Confirm how the three expected items are currently parsed, then add a warning for the invalid anchor reference and verify that valid piclists remain unaffected.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.