Rename edit_permission_overwrites to edit_permission_overwrite

[GoogolGenius]

Summary

Deprecation. Renames edit_permission_overwrites to edit_permission_overwrite.

Checklist

• I have run nox and all the pipelines have passed.
• I have made unittests according to the code I have added/modified/deleted.

Related issues

https://discord.com/channels/574921006817476608/700378161526997003/979493994092449802

[parafoxia]

Pretty sure "overwrites" is correct here. The phrase "edit permission overwrite" makes no sense.

[zunda-arrow]

Pretty sure "overwrites" is correct here. The phrase "edit permission overwrite" makes no sense.

The discord API docs also refers to it as "permission overwrites"

[GoogolGenius]

Pretty sure "overwrites" is correct here. The phrase "edit permission overwrite" makes no sense.

Hmm I thought and agreed with davfsa that "overwrite" made more sense because it edits a specific entry if I understand the method correctly.

[GoogolGenius]

Pretty sure "overwrites" is correct here. The phrase "edit permission overwrite" makes no sense.

The discord API docs also refers to it as "permission overwrites"

This form is used throughout hikari as well but it's this specific method that edits only a single entry I believe for an overwrite?

[GoogolGenius]

I'll add the fragment later by the way.

[davfsa]

This would need deprecation of the old method instead of removal to not turn it into a breaking change. Fragment file should update to reflect that too

[davfsa]

Pretty sure "overwrites" is correct here. The phrase "edit permission overwrite" makes no sense.

There is currently an inconsistency in the lib with this name, with one method calling it overwrites and another one overwrite. Since you are editing a specific permission overwrite, I think the singular is more fitting.

This was fact a todo of mine that seems to have been snipped, lol

[GoogolGenius]

This was fact a todo of mine that seems to have been snipped, lol

Heh it was, I just thought I could do it anyway haha.

[GoogolGenius]

@davfsa Should the tests should use the old name or new name?

[GoogolGenius]

Nvm about review, this is failing CI, let me fix.

Made some silly mistakes lol

[Jonxslays]

@davfsa Should the tests should use the old name or new name?

The old deprecated method and the new method should both be tested up until the deprecated method is removed.

[GoogolGenius]

@davfsa Should the tests should use the old name or new name?

The old deprecated method and the new method should both be tested up until the deprecated method is removed.

What about methods that use that method? They can just be updated with the new name and the test changed right?

[parafoxia]

Pretty sure "overwrites" is correct here. The phrase "edit permission overwrite" makes no sense.

There is currently an inconsistency in the lib with this name, with one method calling it overwrites and another one overwrite. Since you are editing a specific permission overwrite, I think the singular is more fitting.

This was fact a todo of mine that seems to have been snipped, lol

Don't you have the ability to edit multiple overwrites with the same method though?

[GoogolGenius]

Pretty sure "overwrites" is correct here. The phrase "edit permission overwrite" makes no sense.

There is currently an inconsistency in the lib with this name, with one method calling it overwrites and another one overwrite. Since you are editing a specific permission overwrite, I think the singular is more fitting.
This was fact a todo of mine that seems to have been snipped, lol

Don't you have the ability to edit multiple overwrites with the same method though?

Hmm, now I'm a bit conflicted here. It makes sense as singular when you look at it from an "overwrite entry" but if you're editing multiple permissions, you can use the bitwise | operator on the hikari.Permissions enum. Then it would be edit_overwrite_permissions rather.

[GoogolGenius]

I'm also looking at how discord.js and discord.py named this and utterly confused 😕

[davfsa]

A permission overwrite is the singular object that consists of a target, what permissions are allowed and which ones are denied.

Since this endpoint only edits a specific one, then edit_permission_overwrite makes more sense than edit_permission_overwrites, as you are only editing one.

I currently can't check and I don't know it of the top of my head, but the method to bulk ediy them is a different one @parafoxia

[parafoxia]

A permission overwrite is the singular object that consists of a target, what permissions are allowed and which ones are denied.

Since this endpoint only edits a specific one, then edit_permission_overwrite makes more sense than edit_permission_overwrites, as you are only editing one.

I currently can't check and I don't know it of the top of my head, but the method to bulk ediy them is a different one @parafoxia

Right yeah, I'm seeing what you mean. I'd always taken a "permission overwrite" to be an overwrite of a specific permission, rather than all permissions for a given entity.

[parafoxia]

@GoogleGenius I've spotted a typo which might as well be fixed in this PR. The docs (existing and updated) say "vale" instead of "value" in the allowed and denied fields.

[GoogolGenius]

@GoogleGenius I've spotted a typo which might as well be fixed in this PR. The docs (existing and updated) say "vale" instead of "value" in the allowed and denied fields.

Thanks, will fix.