search

pieces-app / pieces-os-client-sdk-for-python

The Pieces OS Client SDK is a powerful code engine package designed for writing applications on top of Pieces OS.
MIT License
26 stars 14 forks source link

Update Table of Contents and Headers to Reflect Api in Python #14

Closed jwafu closed 2 months ago

jwafu commented 8 months ago

For Example

The current readme looks like this:

Screenshot 2024-02-16 at 1 13 04 PM

api_response = api_instance.connect(seeded_connector_connection=seeded_connector_connection)

Here the usage of api_instance.connect() should be applied to the header and link in table of contents instead of using this /endpoint/connection syntax.

So the header for connect (as an example) would be just :

api_instance.connect()

instead of

/connect

HarshitNagpal29 commented 8 months ago

@jordan-pieces Sir i have created a PR(https://github.com/pieces-app/pieces-os-client-sdk-for-python/pull/15) please review it once, and please tell if it need any changes.