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

crawler api docs updated. #1388

Merged
merged 1 commit into from
Sep 1, 2021
Merged

crawler api docs updated. #1388

merged 1 commit into from
Sep 1, 2021

Conversation

akkefa
Copy link
Contributor

@akkefa akkefa commented Sep 1, 2021

Proposed changes:

  • crawler API docs updated.

@julian-risch julian-risch self-requested a review September 1, 2021 09:59
Copy link
Member

@julian-risch julian-risch left a comment

Choose a reason for hiding this comment

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

@akkefa Looks good to me! We are still working on a GitHub action that keeps the docs in sync with the code automatically by running ./generate_docstrings.sh as described here: https://github.com/deepset-ai/haystack/tree/master/docs
Just out of curiosity, did you run this script or did you change the crawler.md file manually?

@julian-risch
Copy link
Member

keeping the docs in sync with the changes made in #1360

@julian-risch julian-risch merged commit 3fc7f3f into deepset-ai:master Sep 1, 2021
@akkefa
Copy link
Contributor Author

akkefa commented Sep 1, 2021

@akkefa Looks good to me! We are still working on a GitHub action that keeps the docs in sync with the code automatically by running ./generate_docstrings.sh as described here: https://github.com/deepset-ai/haystack/tree/master/docs
Just out of curiosity, did you run this script or did you change the crawler.md file manually?

I changed the crawler.md file manually.

@akkefa akkefa deleted the crawler_api_doc_updated branch September 1, 2021 14:36
@julian-risch
Copy link
Member

@akkefa Looks good to me! We are still working on a GitHub action that keeps the docs in sync with the code automatically by running ./generate_docstrings.sh as described here: https://github.com/deepset-ai/haystack/tree/master/docs
Just out of curiosity, did you run this script or did you change the crawler.md file manually?

I changed the crawler.md file manually.

Okay, thanks for letting us know. We will make sure that's not necessary anymore as soon as the GitHub actions is running (again) and automatically takes care of that.

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.

None yet

2 participants