search

rust-lang / datafrog

A lightweight Datalog engine in Rust
Apache License 2.0
796 stars 43 forks source link

Improve example code provided in 'README' file #31

Closed regexident closed 3 years ago

regexident commented 3 years ago

The example code provided in the readme calls variable.complete() where it should be calling nodes_var.complete().

It could also make it more obvious what kind of types nodes and edges are supposed to be and where they are supposed to come from.

shepmaster commented 3 years ago

You could consider using https://docs.rs/doc-comment/0.3.3/doc_comment/ or the equivalent nightly functionality to include the readme in CI runs

regexident commented 3 years ago

@shepmaster If it's something the team would be okay with/appreciate, then I'd be happy to integrate doc_comment!

shepmaster commented 3 years ago

Yeah, I should have been clearer that the “you” was the project, not just for you / this pr. 😅

ecstatic-morse commented 3 years ago

Thanks @regexident. And doc_comment would be cool too!

shepmaster commented 3 years ago

doc_comment would be cool too!

No longer needed, so long as your MSRV is 1.54

regexident commented 3 years ago

Thanks @ecstatic-morse!