Update Index and IndexInterface docstrings with RST formatting and code examples #552
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates all docstrings for methods in the
Indexclass and the underlyingIndexInterfaceclass to use proper RST syntax with comprehensive code-block examples.Changes
Updated all Index class method docstrings with:
Updated IndexInterface class docstrings to:
:param:and:type:syntax in favor of Args sectionsMethods Updated
All methods in both classes now have complete, up-to-date docstrings:
upsert,upsert_from_dataframe,upsert_recordssearch,search_recordsdelete,fetch,fetch_by_metadataquery,query_namespacesupdate,describe_index_statslist,list_paginatedcreate_namespace,describe_namespace,delete_namespacelist_namespaces,list_namespaces_paginatedstart_import,list_imports, etc.)Impact