finitomata icon indicating copy to clipboard operation
finitomata copied to clipboard

Published 20 hours ago • verified publisher icon am-kantox

renaming `Parser.Mermaid`

Open egidijusz opened this issue 2 years ago • 2 comments

Related to #25

Maybe it would be worth it to rename Parser.Mermaid to Parser.Flowchart or Parser.MermaidFlowchart or something like that?

I could go ahead and do it if you're okay with this.

egidijusz avatar Oct 08 '22 08:10 egidijusz

Hi @egidijusz, thanks for having your hands dirty with this, I appreciate it.

I am strongly against renaming because it breaks backward compatibility. But in general, you are absolutely right. So I’d go with allowing regular atoms in use Finitomata clause for predefined syntaxes instead.

That said, we allow :"Elixir.Foo.Bar.Baz" atoms for custom syntaxes, or deprecated Finitomata.{Mermaid, PlantUML}, or :state_diagram and/or :flowchart for predefined ones. Also, we clean up the documentation, getting rid of any mention of deprecated Finitomata.{Mermaid, PlantUML}.

If it sounds OK, the PR would be strongly appreciated.

am-kantox avatar Oct 08 '22 10:10 am-kantox

Yes, that sounds very good. I'll give it a try in coming days.

I'll keep this Issue open, so I can attach the PR to it.

egidijusz avatar Oct 09 '22 07:10 egidijusz