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

fix doc builds after recent changes #494

Closed
wants to merge 1 commit into from

Conversation

pmeier
Copy link
Member

@pmeier pmeier commented Aug 20, 2024

This is to get the CI green again on the corpus-dev branch. We still need to add actual documentation for the changes we have made. I'll flag some of them below.

@pmeier pmeier added area: documentation 📖 Improvements or additions to documentation dev: corpus labels Aug 20, 2024
@pmeier pmeier requested a review from nenb August 20, 2024 08:00
Comment on lines +284 to +285
if not isinstance(input, collections.abc.Collection):
input = [input]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Driveby to also allow single documents.

*,
source_storage: Union[Type[SourceStorage], SourceStorage],
assistant: Union[Type[Assistant], Assistant],
corpus_name: Optional[str],
corpus_name: Optional[str] = None,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nenb I've added a default value here, because I don't want to force users to always set this one.

"source_storage": source_storages.RagnaDemoSourceStorage.display_name(),
"assistant": DemoStreamingAssistant.display_name(),
"corpus_name": None,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably want to have this as default value as well.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this still valid after your comments in #493?

Copy link
Contributor

@nenb nenb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems fine, but I'm not 💯 sure if you want to set the corpus_name as None or use a sentinel after #493.

@pmeier
Copy link
Member Author

pmeier commented Aug 21, 2024

Superseded by #498.

@pmeier pmeier closed this Aug 21, 2024
@pmeier pmeier deleted the corpus-dev-docs-cleanup branch August 21, 2024 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 Improvements or additions to documentation dev: corpus
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

2 participants