sphinx-proof icon indicating copy to clipboard operation
sphinx-proof copied to clipboard

[DISC] `proof:proof` has no label option

Open mmcky opened this issue 4 years ago • 2 comments

@najuzilu is there a reason for not supporting label option for proof:proof. It seems that you're suggesting to use tags (i.e. (tag-here)=) syntax provided by myst

mmcky avatar Aug 31 '20 04:08 mmcky

I noticed that proofs are not referenced as often as theorems, corollaries, and conjectures. Since they're not numbered either (which is common for LaTeX proofs), I couldn't decide what the default link text would look like when referenced. Tags on the other hand, don't have a default link text so the user would have to provide it.

I am open to adding a label option for proofs. What do you think the default link text would look like?

One possibility could be "Proof of Theorem #" where the label provided in the proof directive could be the label of its theorem directive.

najuzilu avatar Aug 31 '20 12:08 najuzilu

What do you think the default link text would look like?

Hmm -- not sure. You make good points re: targets / tag approach and default link text. Given there is no title text or default numbering your approach might be the best.

I guess if we were to add it then perhaps it would switch on numbering by default and use that.

mmcky avatar Sep 01 '20 02:09 mmcky