Career models: the comment on ResumeItem.order is written twice #614

New issue

Closed

opened 2026-10-01 10:48:24 +00:00 by tiagoagueda · 1 comment

tiagoagueda commented

2026-10-01 10:48:24 +00:00

Owner

Found on 2026-09-29 in a read-only review of postulo at 95348908d, reading the career models.

Checked again on 2026-10-01 against main at 0a5cad587: still present.

The #: comment above ResumeItem.order is repeated: resume/models.py:36-38 and resume/models.py:39-41 are the same three lines, word for word. Anyone who edits the field's documentation has two copies to keep in step, and Sphinx-style #: doc comments render the text twice.

Where: resume/models.py:36-41 (ResumeItem.order).
What happens: the doc comment reads "The person's own order for the section, dense and exactly what the overview shows: … Hidden on the entry's form unless Settings > Appearance says otherwise." twice in a row.
Why it matters: a maintenance cost only; a later edit to one copy leaves the other stale.
Fix: delete lines 39-41.

Done when

resume/models.py carries the comment once; no test is needed.

Found on 2026-09-29 in a read-only review of postulo at 95348908d, reading the career models. Checked again on 2026-10-01 against `main` at `0a5cad587`: still present. The `#:` comment above `ResumeItem.order` is repeated: `resume/models.py:36-38` and `resume/models.py:39-41` are the same three lines, word for word. Anyone who edits the field's documentation has two copies to keep in step, and Sphinx-style `#:` doc comments render the text twice. - **Where:** `resume/models.py:36-41` (`ResumeItem.order`). - **What happens:** the doc comment reads "The person's own order for the section, dense and exactly what the overview shows: … Hidden on the entry's form unless Settings > Appearance says otherwise." twice in a row. - **Why it matters:** a maintenance cost only; a later edit to one copy leaves the other stale. - **Fix:** delete lines 39-41. ## Done when - `resume/models.py` carries the comment once; no test is needed.

tiagoagueda added this to the 0.6.0 milestone

2026-10-01 10:48:24 +00:00

tiagoagueda added the

enhancement

tier

labels

2026-10-01 10:48:24 +00:00

tiagoagueda referenced this issue from a commit

2026-10-05 23:05:04 +00:00

Write the ResumeItem.order comment once

tiagoagueda commented

2026-10-06 09:31:59 +00:00