Missing change from Role#color deprecation #7664
Conversation
| | flags | integer | [role flags](/docs/topics/permissions#role-object-role-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) | | ||
|
|
||
| Roles without colors (`color == 0`) do not count towards the final computed color in the user list. | ||
| Roles without colors (`colors.primary_color == 0`) do not count towards the final computed color in the user list. |
There was a problem hiding this comment.
🤔 should it be both? colour isn't going away (even though it's deprecated), so shouldn't we document this for both values?
There was a problem hiding this comment.
No. If I were a new developer, I want to see the current state of the API, not the past and mentions of deprecated behaviour.
There was a problem hiding this comment.
The flip side of which is - if I'm a developer still using the deprecated API, I still want to know what's going on. I may not migrate to the new API for a while.
We might want two sentence though - it should still be clear that color is deprecated.
Maybe something like:
Roles without colors (`colors.primary_color == 0`) do not count towards the final computed color in the user list. If you are using the deprecated `color` property, it also acts in the same way.
Or something like that.
There was a problem hiding this comment.
I agree we want to know that a field is deprecated (at least until a new API version removes it).
However, the table above already conveys this information clearly, and IMO, footnotes should be kept light and use only the new field.
There was a problem hiding this comment.
So apparently that is the general guide for these docs 👍🏻 I stand corrected.
In which case, let's take this live! 🚀
4 participants
Since
coloron role objects is deprecated the remark should reference thecolorsproperty now.