Skip to content

Conversation

@Michael-JB
Copy link
Collaborator

Update DocumentInfo class to improve clarity and precision of its description and arguments, and refine the description of the list_documents method in DocumentIndexClient to better reflect its functionality.

Description

No description.

Before Merging

  • Review the code changes
    • Unused print / comments / TODOs
    • Missing docstrings for functions that should have them
    • Consistent variable names
    • ...
  • Update changelog.md if necessary
  • Commit messages should contain a semantic label and the ticket number
    • Consider squashing if this is not the case

Update DocumentInfo class to improve clarity and precision of
its description and arguments, and refine the description of the
list_documents method in DocumentIndexClient to better reflect its
functionality.
@Michael-JB Michael-JB merged commit d7f44ca into main Nov 28, 2024
4 checks passed
@Michael-JB Michael-JB deleted the di-146-improve-documents-api-docs branch November 28, 2024 17:00
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.

4 participants