Skip to content

QEP-1 v4: codify the in-document appendix #37

Open

Description

@mmcky

QEP-5 is the second QEP to carry a normative machine-readable appendix — its Code in brief block, bounded by <!-- qep-appendix: code-in-brief --> and <!-- /qep-appendix --> — after QEP-2's co-located yml. Two instances was the agreed trigger for generalising the convention into QEP-1. QuantEcon/cli#50 consumes QEP-5's block by substring extraction, so the convention has a consumer now.

Proposed shape, to be settled on the amendment pull request:

  • an optional, normative block bounded by <!-- qep-appendix: <id> --> and <!-- /qep-appendix -->, extractable as a substring with no markdown parsing;
  • any change inside the block is a substantive amendment and bumps version;
  • the QEP names the tool that consumes the block;
  • everything stays in the one markdown file: a fenced block for data, a GitHub alert for prose;
  • decide whether QEP-2's yml migrates into a fenced block or stays as the one file-form exception. The check in check-labels.mjs assumes the file form today.

This is a substantive amendment to QEP-1 (v3 → v4) and needs a second reader. Lands after the rollout has exercised the block at least once, so the convention is written from use.

Activity

  1. added theissue type on Sep 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions