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

chore: enforcing API consistency (also across FFI) #49

Merged
merged 20 commits into from
Oct 16, 2024
Merged

Conversation

zaaarf
Copy link
Member

@zaaarf zaaarf commented Oct 15, 2024

To make development easier, so far we've been lax enough with naming and typing.

In an effort to make the API more consistent across languages (and to amend some questionable naming choices) we're doing a round of mass renaming. And, in some cases, of adding stuff that probably should've been there and bugfixing (especially in the realm of inconsistent method signatures).

Honorable mentions: the method formerly known as list_buffer_users, who was implemented correctly in the glue a grand total of 1 time (JavaScript, gg @frelodev).

Feel free to add any fixes if we missed anything.

@zaaarf zaaarf marked this pull request as ready for review October 15, 2024 23:10
@zaaarf zaaarf requested review from alemidev, frelodev and ghyatzo and removed request for alemidev and frelodev October 15, 2024 23:10
Copy link
Member

@ghyatzo ghyatzo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reviewed the changes, also the python part. The config constructor signature was incorrectly changed (unless there was a reason for it?) so that should be reverted.

I've left some comments where I had some doubts.

<3

src/client.rs Show resolved Hide resolved
src/api/event.rs Show resolved Hide resolved
src/ffi/python/mod.rs Outdated Show resolved Hide resolved
src/ffi/python/mod.rs Show resolved Hide resolved
@zaaarf zaaarf changed the title chore: renaming chore: enforcing API consistency across FFI Oct 16, 2024
@zaaarf zaaarf changed the title chore: enforcing API consistency across FFI chore: enforcing API consistency (also across FFI) Oct 16, 2024
alemidev
alemidev previously approved these changes Oct 16, 2024
frelodev

This comment was marked as resolved.

src/ffi/js/workspace.rs Outdated Show resolved Hide resolved
@zaaarf zaaarf merged commit d7c9acd into dev Oct 16, 2024
96 checks passed
@zaaarf zaaarf deleted the chore/rename branch October 16, 2024 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core This issue is related to the core Rust library tweak Code quality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants