-
Notifications
You must be signed in to change notification settings - Fork 26
Open
Labels
requester: Aalto teacherThe issue is raised by a teacher from Aalto UniversityThe issue is raised by a teacher from Aalto Universitytype: bugThis is a bug which is critical for the correct operation of the systemThis is a bug which is critical for the correct operation of the system
Description
A teacher tried to use the code-block directive inside the annotation 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 the annotation directive. Could the error message be more clear and explicit?
(NB. code-block may be used inside annotated, but not inside annotation 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:
Exception occurred:
File "/usr/local/lib/python3.7/dist-packages/docutils/nodes.py", line 652, in __getitem__
return self.attributes[key]
KeyError: 'name'
Internal ticket:
https://rt.cs.aalto.fi/Ticket/Display.html?id=24428
Metadata
Metadata
Assignees
Labels
requester: Aalto teacherThe issue is raised by a teacher from Aalto UniversityThe issue is raised by a teacher from Aalto Universitytype: bugThis is a bug which is critical for the correct operation of the systemThis is a bug which is critical for the correct operation of the system