Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update python client examples #126

Merged
merged 7 commits into from
May 22, 2022
Merged

update python client examples #126

merged 7 commits into from
May 22, 2022

Conversation

StefanBogdan
Copy link
Member

What's being changed:

Fix python-examples so they are in-line with the latest version. Change style so it is more readable.

Type of change:

  • Documentation updates (non-breaking change which updates documents)

How Has This Been Tested?

I built the website locally and went through all the pages to check if they are as expected.

@StefanBogdan StefanBogdan requested a review from bobvanluijt May 17, 2022 08:34
@StefanBogdan
Copy link
Member Author

Hi @bobvanluijt , I changes the python examples and added the missing Change logs. I kept the 3 Methods for Batching but restructured it, can you take a look and let me know if it is better or if I should delete the methods that are confusing.

Let me know if I missed something.

@bobvanluijt
Copy link
Member

Note to self: #127

@bobvanluijt bobvanluijt requested a review from etiennedi May 18, 2022 13:40
@bobvanluijt
Copy link
Member

Hi @StefanBogdan – this is a good start but improvements can be made, I did add @etiennedi as a reviewer too.

A few things about the batching page.

  • I would like to change the order to: 1) create data objects, 2) add references, 3) delete.
  • There is too much information in the 1st section (the add data section).
    • Please make subsections: 1) configuration, 1) dynamic batching, 2) manual batching.
  • Do not include the error handling function but mention that this is important and refer to the error handling section.

@etiennedi – this might solve some in this request too (can you please double check): #127

@StefanBogdan StefanBogdan force-pushed the python-client-update branch from 97bef20 to f7ca796 Compare May 21, 2022 20:52
@StefanBogdan
Copy link
Member Author

@bobvanluijt the /v1/batch looks better this way, thanks. Have you had a chance to look at the Python page too? I added more info on Batching there.

@bobvanluijt
Copy link
Member

@StefanBogdan – good point, I've moved a few things to the Python page as well. After merging we can ask the community for feedback

@bobvanluijt bobvanluijt merged commit bf9e9af into main May 22, 2022
@bobvanluijt bobvanluijt deleted the python-client-update branch May 22, 2022 23:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants