Expand T::Struct docs with various examples of rules #6462
Conversation
|
Seeing the order on the enum docs is inverted compared to what I have here: I'll tweak this PR. |
79d7c44 to
a0e41be
Compare
This covers most (if not all) rules other than: - deprecated ones (eg :ifunset) - things that look like Stripe internals (:foreign, :redaction and :sensitivity) Also fix the 'serialize' example return value to show string keys
a0e41be to
7557336
Compare
|
Thanks for tackling this! We have been limping along with only Stripe-internal docs for a lot of these options for a long time. froydnj is out this week, so I'm going to take this off his plate. I'm a little busy for the rest of the day, but I should be able to take this on either tomorrow or wednesday. I'll also go over and try to merge some of the Stripe-internal docs that we have into this doc in places where it makes sense. |
|
I started out leaving feedback on this PR, but as I was going, I realized that I think it would be better for me to just open a separate PR to update these docs. Feel free to leave your feedback on that PR, but I believe it should at least incorporate as much as this PR adds to the doc, with some other expanded content. |
After discussion on the Sorbet Slack I found out T::Struct can do a lot more than this page initially let me to believe.
The changes cover most (if not all) prop rules other than:
:ifunset):foreign,:redactionand:sensitivity)Also fix the 'serialize' example return value to show string keys.