Skip to content

Index strings #188

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jul 1, 2023
Merged

Index strings #188

merged 2 commits into from
Jul 1, 2023

Conversation

byronnlandry
Copy link
Contributor

@byronnlandry byronnlandry commented Jun 30, 2023 •
edited
Loading

Problem

Current Python client documentation automation plans consume Python client docstrings. However, current docstrings are sometimes incomplete or unclear.

Solution

This PR attempts to clarify and complete Python client docstrings.

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)

Test Plan

Describe specific steps for validating this change.

@byronnlandry byronnlandry requested review from jhamon and rajat08 June 30, 2023 22:17
@byronnlandry byronnlandry merged commit 4640c4c into main Jul 1, 2023
@byronnlandry byronnlandry deleted the index_strings branch July 1, 2023 23:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jhamon jhamon jhamon approved these changes

@rajat08 rajat08 Awaiting requested review from rajat08

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@byronnlandry @jhamon