Skip to content
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

Implement Mermaid diagrams #56

Merged
merged 3 commits into from
Sep 11, 2022
Merged

Implement Mermaid diagrams #56

merged 3 commits into from
Sep 11, 2022

Conversation

glesica
Copy link
Owner

@glesica glesica commented Jul 19, 2022

See https://mermaid-js.github.io/mermaid/#/./classDiagram

There are still some issues:

  1. There is no name spacing, which doesn't seem to be supported by Mermaid

Since name spacing doesn't appear to be supported, just assume it's not an issue. We can revisit later, but there's really no good solution other than mashing the names together.

  1. Only limited testing so far (just using DCDG itself)

Added some tests. Beyond that, existing tests are fairly general. Would still like to add a gold file test for each builder.

  1. Type names with () cause fields to show up as methods

Just elide the parens and call it a day. For most use cases this should be fine. We may need to think about callbacks with parameters.

@glesica glesica added the enhancement New feature or request label Jul 19, 2022
@plumsky plumsky mentioned this pull request Aug 16, 2022
@glesica glesica merged commit 08b11a2 into master Sep 11, 2022
@glesica glesica deleted the mermaid branch September 11, 2022 19:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant