Skip to content

Conversation

@Lowsecs
Copy link

@Lowsecs Lowsecs commented Apr 18, 2025

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

@Lowsecs Lowsecs changed the title initial commit - intent to start working on issue #233 addressing task "Remove C++ API References" re. issue #233 Apr 24, 2025
@Lowsecs
Copy link
Author

Lowsecs commented Apr 24, 2025

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 Lowsecs marked this pull request as ready for review April 24, 2025 01:36
@Lowsecs Lowsecs mentioned this pull request Apr 24, 2025
@Lowsecs
Copy link
Author

Lowsecs commented Apr 24, 2025

Doc changes validated via cargo test --doc

@Indra-db Indra-db closed this Jul 30, 2025
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.

2 participants