-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Open
Labels
bugIssue is reported as a bugIssue is reported as a bugteam:VMAssigned to OTP team VMAssigned to OTP team VM
Description
Describe the bug
Using binaries or sigils in -moduledoc is silently swallowed and only produces none in doc chunks. This is inconsistent with the -doc attribute which accept all forms of strings.
The documentation doesn't really specify the allowed format but mentions the word "string" a few times.
This took a long while to debug after discovering that ex_doc didn't add my module descriptions 😅
To Reproduce
| Format | -moduledoc |
-doc |
|---|---|---|
"string" |
✅ works | ✅ works |
"""triple""" |
✅ works | ✅ works |
<<"binary">> |
none |
✅ works |
~"sigil" |
none |
✅ works |
~"""triple""" |
none |
✅ works |
Expected behavior
All formats work everywhere. Or at least an error if the format is not allowed.
Affected versions
28.4.1
Additional context
None.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
bugIssue is reported as a bugIssue is reported as a bugteam:VMAssigned to OTP team VMAssigned to OTP team VM