Skip to content

give each multipledispatch-registered implementation a unique name#1496

Open
st-- wants to merge 7 commits into
developfrom
st/quickfix/dispatch_docs
Open

give each multipledispatch-registered implementation a unique name#1496
st-- wants to merge 7 commits into
developfrom
st/quickfix/dispatch_docs

Conversation

@st--
Copy link
Copy Markdown
Member

@st-- st-- commented Jun 4, 2020

so that docs are generated correctly. resolves #1494

@st-- st-- requested review from awav and vdutor June 4, 2020 11:53
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 4, 2020

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.08%. Comparing base (7b2a0c8) to head (d3842ee).
⚠️ Report is 283 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1496   +/-   ##
========================================
  Coverage    95.08%   95.08%           
========================================
  Files           85       85           
  Lines         3782     3784    +2     
========================================
+ Hits          3596     3598    +2     
  Misses         186      186           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@vdutor vdutor left a comment

Choose a reason for hiding this comment

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

Naming is unique but not really consistent across different multiple-dispatch methods. Can we follow one convention like, for example, _name__Type1__Type2?


@conditional.register(object, InducingVariables, Kernel, object)
def _conditional(
def single_output_conditional(
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
def single_output_conditional(
def conditional__InducingVariables__Kernel(


@conditional.register(object, object, Kernel, object)
def _conditional(
def plain_conditional(
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
def plain_conditional(
def conditional__object__Kernel(

object,
)
def _Kuf(
def _Kuf__Fallback__LinearCoregionalization(
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Are you sure about the fallback here?

Copy link
Copy Markdown
Member

@awav awav left a comment

Choose a reason for hiding this comment

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

I recommend reconsidering names. At least remove double underscores. Often in names, you cannot encode all combinations.

@st--
Copy link
Copy Markdown
Member Author

st-- commented Jun 10, 2020

Names weren't consistent beforehand, either, and they're not really needed for anything specific. However, giving them unique names (note- names only need to be unique within a given python module) fixes the bug in our documentation, so can we please figure out something simple that makes it work as opposed to trying to find a perfect solution? I don't think it's worth the effort making everything fully consistent across the code-base. It's not practically feasible to encode all combinations. Sometimes we register the same implementation for different type pairs.

@st--
Copy link
Copy Markdown
Member Author

st-- commented Jun 23, 2020

@awav would you be satisfied by "simply replace all double-underscores with single-underscores"?
@vdutor what's the minimum that'd satisfy you to approve this PR?

@st-- st-- requested review from awav, insysion and vdutor July 2, 2020 10:22
@insysion insysion self-assigned this Jul 16, 2020
@insysion
Copy link
Copy Markdown
Contributor

I'll be addressing the concerns of @awav and @vdutor week beginning 28th October

@st-- st-- added the bug label Oct 5, 2020
@vdutor
Copy link
Copy Markdown
Contributor

vdutor commented Nov 18, 2020

@insysion, are you still planning to do this?

@insysion insysion removed their assignment Oct 4, 2021
Copy link
Copy Markdown
Contributor

@insysion insysion left a comment

Choose a reason for hiding this comment

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

Leaving a comment to remove me from requested reviews

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation for _conditional function incorrect

4 participants