Flecs-Rust icon indicating copy to clipboard operation
Flecs-Rust copied to clipboard

addressing task "Remove C++ API References" re. issue #233

Open Lowsecs opened this issue 9 months ago • 2 comments

draft pr to signal intent to work on issue#233 Improve EntityView docs

Lowsecs avatar Apr 18 '25 07:04 Lowsecs

I've scoped my changes to address "Remove C++ API References:" as the task exceeded my timebox of ~day

I recommend that the this task is split off into 1/2 tasks, as for me at least, it's not really feasible to go further given the bounty price and time cost.

  1. Improve Clarity
  2. Add Examples

There is a fair bit of work in this regard as the existing documentation is still subtly rooted in C/C++ conventions, and you obviously need to learn what each function does in order to document it.

I'm fairly new to the code base, but I see mixed messaging between the "C++" removal task and comments at the top of the file, which state that the aim is to mirror C++ entity and entity_builder classes. I suppose the bindings have graduated to a point where they no longer need this commenting?

Lowsecs avatar Apr 24 '25 01:04 Lowsecs

Doc changes validated via cargo test --doc

Lowsecs avatar Apr 24 '25 01:04 Lowsecs