Explicit and easy-to-understand errors in the annotation directive #173
Labels
requester: Aalto teacher
The issue is raised by a teacher from Aalto University
type: bug
This is a bug which is critical for the correct operation of the system
A teacher tried to use the
code-block
directive inside theannotation
directive. The compilation error message about this is not easy to understand and thus, the teacher did not know that the problem stems from the invalid use of theannotation
directive. Could the error message be more clear and explicit?(NB.
code-block
may be used insideannotated
, but not insideannotation
that defines the text that is shown during mouse hovering.)https://github.com/apluslms/a-plus-rst-tools/blob/master/directives/annotated.py
https://github.com/apluslms/a-plus-rst-tools/blob/master/README.md#11-annotated-code-blocks
The confusing error message that the teacher saw was this traceback:
Internal ticket:
https://rt.cs.aalto.fi/Ticket/Display.html?id=24428
The text was updated successfully, but these errors were encountered: