Styling: README should import only the class and method instead of entire module #23
Labels
documentation
Improvements or additions to documentation
good first issue
Good for newcomers
styling
Issues related to code styling/best practices
Currently, the (README file)[https://github.com/openfga/python-sdk/blob/main/README.md] suggests importing openfga_sdk as a whole. For example, we have
import openfga_sdk
.This is contrary to best practice in that only the relevant classes/methods should be imported. Instead, we should do something like
This will also require updating the example so that it does not have the prefix openfga_sdk.
As an example,
should become
Ideally, we will also fix the SDK generator so that newly generated python SDKs will have the corresponding changes. This is tracked as openfga/sdk-generator#126. However, if that is difficult to do, simply focusing on the Python SDK side https://github.com/openfga/python-sdk/blob/main/README.md will help us as well.
The text was updated successfully, but these errors were encountered: