search

lana555 / dynamatic

MIT License
86 stars 38 forks source link

Consider changing `.dot` extension to avoid collision with GraphViz. #2

Open boqwxp opened 4 years ago

boqwxp commented 4 years ago

I'm not sure how much infrastructure is built around using the .dot file extension, but if the answer is "not much", you should consider changing the file extension to avoid collision with GraphViz files. These days GraphViz seems to have migrated to using the .gv extension, but there are plenty of people and projects using the .dot extension.

In fact, when I first saw .DOT in the README.md, my immediate assumption was that it was talking about GraphViz files, and it took me 5-10s more to read the context and figure out, "Oh, no, it's just a bespoke file format".

Again, if there's a lot of effort invested in experiment scripts etc. hardcoded with the .DOT extension, changing it isn't worth it. But if it's just a matter of tweaking a constant string somewhere and updating the documentation, I think it would be ideal to change it to something else.

lana555 commented 4 years ago

Hi,

sorry for the delay and thanks for the info! We indeed use dot because of GraphViz---some parts of our code (Buffers) use GraphViz libraries and we use GraphViz to visualize dot files as PNG or PDF.