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

Improve example code provided in 'README' file #31

Merged
merged 1 commit into from
Aug 4, 2021

Conversation

regexident
Copy link
Contributor

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
Copy link
Member

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
Copy link
Contributor Author

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

@shepmaster
Copy link
Member

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

@ecstatic-morse ecstatic-morse merged commit 8fc97c1 into rust-lang:master Aug 4, 2021
@ecstatic-morse
Copy link
Contributor

Thanks @regexident. And doc_comment would be cool too!

@shepmaster
Copy link
Member

doc_comment would be cool too!

No longer needed, so long as your MSRV is 1.54

@regexident regexident deleted the fix-readme-example branch August 14, 2021 13:48
@regexident
Copy link
Contributor Author

Thanks @ecstatic-morse!

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

Successfully merging this pull request may close these issues.

3 participants