rust-sfml icon indicating copy to clipboard operation
rust-sfml copied to clipboard

Suggest + volunteer: add more doc examples

Open richelbilderbeek opened this issue 3 years ago • 2 comments

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?

richelbilderbeek avatar Jan 07 '22 11:01 richelbilderbeek

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

crumblingstatue avatar Jan 07 '22 14:01 crumblingstatue

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

  • [x] sfml::audio::Sound (already exists)
  • [x] sfml::audio::SoundBuffer (already exists)
  • [x] 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

richelbilderbeek avatar Jan 07 '22 18:01 richelbilderbeek