@@ -196,12 +196,29 @@ The thorough preflight is opt-in because it parses twice and writes twice.
196196Ordinary parsing continues to log detected block failures and exposes them in
197197``library.failed_blocks `` without paying that additional cost on every read.
198198
199- On incompatibility, the text and JSON CLI reports include a pre-filled GitHub
200- issue-form URL unless ``--no-issue-link `` is supplied. The URL is only a draft:
201- the command does not open it, perform a network request, or create an issue. It
202- contains environment and check metadata plus a source hash, but no file path,
203- bibliography content, or source snippet. Review the draft and add only a minimal
204- example that is safe to disclose.
199+ On incompatibility, the text and JSON CLI reports include a pre-filled,
200+ privacy-safe GitHub issue-form URL unless ``--no-issue-link `` is supplied. The
201+ URL is only a draft: the command does not open it, perform a network request, or
202+ create an issue. It contains environment and check metadata plus a source hash,
203+ but no file path, bibliography content, or source snippet.
204+
205+ The text report also points to the explicit source-disclosure option:
206+
207+ .. code-block :: console
208+
209+ $ python -m bibtexparser check references.bib --include-source-in-issue-link
210+
211+ That command keeps the privacy-safe draft and adds a second draft containing an
212+ exact failed block when the checker can extract a bounded reproduction. A
213+ duplicate-key reproduction includes both relevant blocks. The checker does not
214+ truncate an oversized block, because a partial block could be invalid or fail
215+ to reproduce the problem; in that case, add a reviewed minimal example
216+ manually.
217+
218+ The source-bearing URL exposes bibliography content in terminal logs, browser
219+ history, and the GitHub draft even if the issue is never submitted. The command
220+ therefore requires explicit opt-in and prints a warning. Review the URL and the
221+ draft carefully before submitting anything.
205222
206223.. _writing_quickstart :
207224
0 commit comments