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

Wish: Add graphviz feature usage to examples/ex1.rs #42

Open
stappersg opened this issue Apr 10, 2022 · 0 comments
Open

Wish: Add graphviz feature usage to examples/ex1.rs #42

stappersg opened this issue Apr 10, 2022 · 0 comments

Comments

@stappersg
Copy link
Contributor

stappersg commented Apr 10, 2022

My wish expressed as a patch:

--- a/examples/ex1.rs
+++ b/examples/ex1.rs
@@ -2,6 +2,9 @@
 //!
 //! A simple example of a state machine which will get stuck in the final state.
 //! A picture depicting the state machine can be found in the README.
+//!
+//! to generate that picture do
+//!   https://github.com/korken89/smlang-rs/issues/42
 
 #![deny(missing_docs)]
 

So a change in examples/ex1.rs, not necessary something that is active, having it as comment is a improvement.

There is no need for changes that will effect the ci build system requiring graphviz being installed.
Just document how to use the graphviz feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant