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

docs:fixed typo (or old documentation) in ipynb tutorial 3 #3033

Merged
merged 2 commits into from
Aug 22, 2022

Conversation

DavidGerva
Copy link
Contributor

@DavidGerva DavidGerva commented Aug 12, 2022

Related Issues

  • no related issue, if I have to open one I will (I didn't find anything about this in the PR doc)

Proposed Changes:

I only fixed the key in the document dictionary format so write_documents() won't raise an error. By the way the write_documents() error is really explanatory. Tutorial updated: Tutorial3_Basic_QA_Pipeline_without_Elasticsearch.ipynb, as far as I understood no need to fix anything in the .py version

How did you test it?

No real-test needed I think, but I went trough the notebook executing every cell and I spot this error adding my own documents: changing the dictionary format fixed it.

Checklist

Just fixed the key in the document dictionary format so `write_documents()` won't raise an error. By the way the `write_documents()` error is really explicative
@DavidGerva DavidGerva requested review from a team as code owners August 12, 2022 13:58
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Member

@tstadel tstadel left a comment

Choose a reason for hiding this comment

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

LGTM!

@tstadel
Copy link
Member

tstadel commented Aug 15, 2022

@DavidGerva could you please run python .github/utils/convert_notebooks_into_webpages.py on your branch and commit the md file, so the final check passes?

@DavidGerva
Copy link
Contributor Author

@DavidGerva could you please run python .github/utils/convert_notebooks_into_webpages.py on your branch and commit the md file, so the final check passes?

Done!

@ZanSara ZanSara merged commit e715dee into deepset-ai:main Aug 22, 2022
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