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

Assess docstring examples quality #19

Closed
lukostaz opened this issue Mar 7, 2019 · 1 comment

Comments

Projects
4 participants
@lukostaz
Copy link
Contributor

commented Mar 7, 2019

Background and Context
AmpliGraph documentation includes examples for each public API.
Some examples may not be up to date with the latest code changes, and some new APIs may miss an example.

Description

  • Make sure all public APIs in the HTML documentation have an example
  • check if each example runs properly. Fix any broken code.
  • make sure HTML rendering of the example is correct
  • Also check the "Examples" section in examples.md.

@lukostaz lukostaz added this to the 1.0 milestone Mar 7, 2019

@lukostaz lukostaz added this to To do in AmpliGraph 1.0 via automation Mar 7, 2019

@chanlevan chanlevan self-assigned this Mar 12, 2019

@chanlevan chanlevan moved this from To do to In progress in AmpliGraph 1.0 Mar 12, 2019

@chanlevan

This comment has been minimized.

Copy link
Contributor

commented Mar 15, 2019

Examples are mismatched in the documentation of load_fb15k_237 function. It should show loading fb15k_237 dataset instead of fb15k

@chanlevan chanlevan moved this from In progress to Done in AmpliGraph 1.0 Mar 15, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.