2shady4u / godot-sqlite

GDExtension wrapper for SQLite (Godot 4.x+)
MIT License
947 stars 82 forks source link

Create wrapper class to make documentation more accessable #97

Closed engineer-pearl closed 1 year ago

engineer-pearl commented 2 years ago

I've been careful not to take too much liberty with the documentation, but I added a little extra where I thought it was needed (like the insert_rows function). Someone with a background in technical documentation probably could have done better.

Functionality wise, clicking on functions brings you to where they're defined, and godot can auto-complete function names. I'd say this means I've accomplished the two biggest goals for this helper class.

I'm not too happy with the file name, file location, or class name though, and am open to suggestions if you've got them.

Do you think the demo project you've written is a sufficient test to ensure the class is feature complete, or are there additional test cases you would recommend I add?

Issue tags: fixes #94

2shady4u commented 2 years ago

Hi @engineer-pearl!

Would it be possible to squash your commits into one? I'll try to properly review your pull request as soon as possible!

engineer-pearl commented 2 years ago

There is a mechanism to squash on pull request: https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests

Perhaps we could use that?

2shady4u commented 2 years ago

There is a mechanism to squash on pull request: https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests

Perhaps we could use that?

It's just much to review a PR for me if the comments are squashed :)

engineer-pearl commented 1 year ago

@2shady4u the squashed version of this pull request is now outdated. Sorry.

engineer-pearl commented 1 year ago

@leprasmurf How are the changes that I made? Can I resolve the conversations?

engineer-pearl commented 1 year ago

@2shady4u Leprasmurf's comments have been resolved.

2shady4u commented 1 year ago

Hi @engineer-pearl

Sorry that it took so long :/ I've finally found some time to review, update and merge this PR.

Thank you for your contribution 🙏