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

Check urls of datasets in code and documentation #88

Open
ynop opened this issue Oct 15, 2019 · 3 comments
Open

Check urls of datasets in code and documentation #88

ynop opened this issue Oct 15, 2019 · 3 comments

Comments

@ynop
Copy link
Owner

ynop commented Oct 15, 2019

The urls used in the code and documentation should be checked for availability (As done for the readme in #87)

Places to check:

  • URLs in the CorpusDownloader classes
  • URLs in the code-doc of CorpusReader classes
@SuperKogito
Copy link

I think it makes sense to automate this using built-in Sphinx functionalities like the ones mentioned here.

@ynop
Copy link
Owner Author

ynop commented Nov 20, 2019

I agree, it definitely should be automated.
But i am not sure how, since some of the links are in the code, so the sphinx solution might not be the best.
Maybe a script could check all important links and generate a small report (via shippable, github actions, ...)

@SuperKogito
Copy link

SuperKogito commented Nov 20, 2019

I will test the Sphinx option this weekend, if it covers the code then that will be sufficient. If not I will look into writing a script that collects all URLs and checks them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants