Skip to content

Conversation

byronnlandry
Copy link
Contributor

Problem

Current plans to automate Python client documentation generation consume client docstrings. Some of these strings are currently incomplete or unclear.

Solution

This PR expands and clarifies the docstrings in the Python client.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Infrastructure change (CI configs, etc)
  • [x ] Non-code change (docs, etc)
  • None of the above: (explain here)

@byronnlandry byronnlandry requested a review from rajat08 June 30, 2023 17:44
@byronnlandry byronnlandry merged commit 6137f08 into main Jun 30, 2023
@byronnlandry byronnlandry deleted the index_strings branch June 30, 2023 19:35
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.

3 participants