openfga / sdk-generator

OpenFGA Client SDK Generator
Apache License 2.0
16 stars 38 forks source link

docs: include retry information in the readme for SDKs #333

Closed ewanharris closed 6 months ago

ewanharris commented 6 months ago

Description

Adds a process for documenting the retry strategy of each SDK in the readme following the other SDK specific readme pieces by introducing a README_retries.mustache file that will be rendered into the readme.

Given that last one, I'm putting this into draft to prevent any merge.

References

320

Review Checklist

ewanharris commented 6 months ago

Heh, I guess this would need to be conditionally rendered in the readme of SDKs that aren't yet compliant with retries

evansims commented 6 months ago

👋 I've added config/clients/python/template/README_retries.mustache to the PR to cover the retry support merged with https://github.com/openfga/sdk-generator/commit/a175fb2ad386a99cc823fe9f0120a7a3142ed6ab earlier today.

I realize the wording is quite different, but I thought I'd propose an alternative approach. I'll be happy to update it if the other approach is preferred, of course. 😄

ewanharris commented 6 months ago

@evansims that sounds much better thank you! I'll apply the edits to the other SDKs tomorrow alongside the changes to source the values from the config!