Skip to content

Conversation

kklein
Copy link
Collaborator

@kklein kklein commented Aug 12, 2022

Currently, building the documentation with sphinx triggers the following errors:

/Users/kevin/Code/datajudge/src/datajudge/requirements.py:docstring of datajudge.requirements.BetweenRequirement.add_row_equality_constraint:4: ERROR: Undefined substitution referenced: "T1 - T2".
/Users/kevin/Code/datajudge/src/datajudge/requirements.py:docstring of datajudge.requirements.BetweenRequirement.add_row_equality_constraint:4: ERROR: Undefined substitution referenced: "T2 - T1".
/Users/kevin/Code/datajudge/src/datajudge/requirements.py:docstring of datajudge.requirements.BetweenRequirement.add_row_equality_constraint:4: ERROR: Undefined substitution referenced: "T1 U T2".
/Users/kevin/Code/datajudge/src/datajudge/requirements.py:docstring of datajudge.requirements.BetweenRequirement.add_row_subset_constraint:4: ERROR: Undefined substitution referenced: "T1-T2".
/Users/kevin/Code/datajudge/src/datajudge/requirements.py:docstring of datajudge.requirements.BetweenRequirement.add_row_subset_constraint:4: ERROR: Undefined substitution referenced: "T1".
/Users/kevin/Code/datajudge/src/datajudge/requirements.py:docstring of datajudge.requirements.BetweenRequirement.add_row_subset_constraint:7: ERROR: Undefined substitution referenced: "T1-T2".
/Users/kevin/Code/datajudge/src/datajudge/requirements.py:docstring of datajudge.requirements.BetweenRequirement.add_row_superset_constraint:4: ERROR: Undefined substitution referenced: "T2-T1".
/Users/kevin/Code/datajudge/src/datajudge/requirements.py:docstring of datajudge.requirements.BetweenRequirement.add_row_superset_constraint:4: ERROR: Undefined substitution referenced: "T2".

This is due to rst relying on | as a marker for substitutions[0]. We could simply escape the characters and leave the notation as is. Since the errors stem from examples which would profit from a math representation anyway, I wrapped them in latex, which

  • Made the errors go away
  • Hopefully improves the user experience in comparison to pseudo code

[0] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions

@codecov
Copy link

codecov bot commented Aug 12, 2022

Codecov Report

Merging #50 (2ae93af) into main (b899598) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #50   +/-   ##
=======================================
  Coverage   93.90%   93.90%           
=======================================
  Files          15       15           
  Lines        1607     1607           
=======================================
  Hits         1509     1509           
  Misses         98       98           
Impacted Files Coverage Δ
src/datajudge/requirements.py 94.50% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@kklein kklein merged commit 7a5d603 into main Aug 12, 2022
@kklein kklein deleted the doc_warnings branch August 12, 2022 09:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants