-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix mermaid dotted arrow #9031
fix mermaid dotted arrow #9031
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #9031 +/- ##
=======================================
Coverage 95.75% 95.75%
=======================================
Files 173 173
Lines 18648 18648
=======================================
Hits 17856 17856
Misses 792 792
|
Nice catch. It would be cool if there was a way to test for this. |
Do you mean like running a mermaid parser to the output file? |
Yeah, but I don't know if there is an easy way to do that. And there are other output formats too, none of which I personally use. I thought I had manually tested the output, but obviously not well enough! |
Well I was just checking that, it seems that mermaid has exposed their parser mermaid-js/mermaid#4 |
Maybe we can fix the issue and backport it in 2.17.x and then later another MR for a long term solution to not introduce this kind of bugs ? |
this issue is not in version 2, got merged in #8824 directly into version 3 |
Thank you for the catch! |
Type of Changes
Description
There is an issue with a mermaid arrow.
Check:
Closes #9030
The issue was introduced in:
#8824
it should be:
mod_c ..> mod_a
as documented here:
https://mermaid.js.org/syntax/classDiagram.html#defining-relationship
github renders mermaid files, and if we try to open this one we get an error, see:
https://github.com/pylint-dev/pylint/blob/ffe1e714a3cfe83b5a627ade6d723489f2e10621/tests/pyreverse/functional/package_diagrams/type_check_imports/packages.mmd
with this fix now the file renders without issue:
https://github.com/pylint-dev/pylint/blob/83ade2f16272153ae077b03c5c8ffd341b03cf25/tests/pyreverse/functional/package_diagrams/type_check_imports/packages.mmd
Originally posted by @agusdmb in #8824 (comment)