Avoiding PyYAML ScannerError
- Dominant language
- Python
- Stars
- 435
- Forks
- 124
- Avg merge
- 5h 40m
- Merged PRs (30d)
- 14
Description
Colons and tick marks inside of YAML fields (such as `hint` within `InlineMultiQuestion` or candidates in a drop-down cell) can raise a `ScannerError: mapping values are not allowed here`. HTML equivalents may be okay.
This appears to be upstream with PyYAML, but affects RELATE.
Will you consider making a note of this on the documentation at https://documen.tician.de/relate/flow.html?
Contributor guide
No contributing guide indexed for this repository
Research direction
Open the flow documentation at https://documen.tician.de/relate/flow.html and review the descriptions of YAML fields such as InlineMultiQuestion hints and drop-down candidates. Add a note about colons and tick marks causing PyYAML ScannerError, including the reported possibility that HTML equivalents may work; the documentation should clearly warn users about this limitation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100