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

Suggest + volunteer: add more doc examples #255

Open
richelbilderbeek opened this issue Jan 7, 2022 · 2 comments
Open

Suggest + volunteer: add more doc examples #255

richelbilderbeek opened this issue Jan 7, 2022 · 2 comments

Comments

@richelbilderbeek
Copy link

Dear rust-sfml maintainers, hi @jeremyletang,

Thanks for rust-SFML: I am very happy I can use one of my favorite graphics libraries on Rust :-)

One of the cool things of Rust is that one can add examples to the documentation, as already done, for example, for the Window struct.

However, for simpler types, the documentation feels incomplete.

For me, a rustling, I would enjoy seeing more examples in the documentation rust-sfml. I even volunteer to do so (sure, we'll probably schedule a quick chat, I will use Pull Requests, etc). The CONTRIBUTING.md could be more helpful in telling me when a PR is likely to be accepted and when not :-)

How do we proceed from here?

@crumblingstatue
Copy link
Collaborator

You could start by listing here types that you feel need examples. I'll review the cases and might even make examples for them.

@richelbilderbeek
Copy link
Author

richelbilderbeek commented Jan 7, 2022

@crumblingstatue, these are types I use most at the moment:

  • sfml::audio::Sound (already exists)
  • sfml::audio::SoundBuffer (already exists)
  • sfml::graphics::Color (added)
  • sfml::graphics::Font
  • sfml::graphics::RenderTarget
  • sfml::graphics::RenderWindow
  • sfml::graphics::Sprite
  • sfml::graphics::Texture
  • sfml::graphics::Transformable
  • sfml::system::Vector2f
  • sfml::window::ContextSettings
  • sfml::window::Event
  • sfml::window::Key
  • sfml::window::Style
  • sfml::SfBox

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

2 participants