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

Documentation for _conditional function incorrect #1494

Open
JamesALeedham opened this issue Jun 3, 2020 · 0 comments · May be fixed by #1496
Open

Documentation for _conditional function incorrect #1494

JamesALeedham opened this issue Jun 3, 2020 · 0 comments · May be fixed by #1496
Labels
Projects

Comments

@JamesALeedham
Copy link

JamesALeedham commented Jun 3, 2020

Check out this page containing API doc for the gpflow.conditionals.conditionals._conditional function (screenshot of key section below). As I understand it, this doc is supposed to say (something like):

  • "If you call the gpflow.conditionals.conditional function and pass in object,InducingVariables,Kernel,object then we'll forward these things to _conditional. Below is the doc for this version of _conditional ..."
  • "If on the other hand you call the gpflow.conditionals.conditional function and pass in object,object,Kernel,object then we'll forward these things to _conditional. Below is the doc for this version of _conditional ..."

But the docs for both versions of _conditional are the same (it's the second, object,object,Kernel,object, version). Sphinx has found two methods with the same name and pasted the documentation it's found last for both of them.

The doc for the 'InducingVariables' version is never shown (starts "Single-output GP conditional...")

image

PS. The _sample_conditional function is implemented differently, and on the surface at least, seems to generate documentation that makes more sense...

@st-- st-- added this to To do in Open bugs via automation Jun 3, 2020
@st-- st-- added the bug label Jun 3, 2020
@st-- st-- moved this from To do to Investigating next in Open bugs Jun 4, 2020
st-- added a commit that referenced this issue Jun 4, 2020
@st-- st-- moved this from Investigating next to Bugfix in progress in Open bugs Jun 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Open bugs
  
Bugfix in progress
Development

Successfully merging a pull request may close this issue.

2 participants