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

Add example to the README.md file #270

Merged
merged 1 commit into from Apr 20, 2022
Merged

Conversation

tiaanl
Copy link
Contributor

@tiaanl tiaanl commented Jan 23, 2022

Add a simple example to the README.md file to show the capabilities of the crate. The README is displayed in many places where developers are evaluating its use and having an example is always useful.

@KodrAus
Copy link
Member

KodrAus commented Feb 27, 2022

Thanks @tiaanl! This looks good to me, but for the README it might be good to put some comments inline with the bitflags! invocation and its use to suggest the macro is how you define a flags type, which then generates a bunch of set-like methods for you. What do you think?

@tiaanl
Copy link
Contributor Author

tiaanl commented Apr 8, 2022

@KodrAus I copied a small comment from the lib.rs docs and also grabbed the example code from there to add more use cases.

Copy link
Member

@KodrAus KodrAus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @tiaanl! Sorry for the radio silence on this one. This looks good to me.

@tiaanl
Copy link
Contributor Author

tiaanl commented Apr 15, 2022

@KodrAus Thanks for the approval. I'm not sure why all the checks are failing. I only changed the README 😕 Any suggestions?

@KodrAus
Copy link
Member

KodrAus commented Apr 20, 2022

That's just changes to Rust's compiler messages so nothing to worry about here. I've fixed those up so will merge this one in. Thanks again!

@KodrAus KodrAus merged commit 186a7bb into bitflags:main Apr 20, 2022
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.

None yet

2 participants