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

Base.promote_noncircular still exists in the doc #32274

Closed
singularitti opened this issue Jun 10, 2019 · 1 comment · Fixed by #32334
Closed

Base.promote_noncircular still exists in the doc #32274

singularitti opened this issue Jun 10, 2019 · 1 comment · Fixed by #32334
Labels
docs This change adds or pertains to documentation good first issue Indicates a good issue for first-time contributors to Julia

Comments

@singularitti
Copy link
Contributor

singularitti commented Jun 10, 2019

It seems that in issue #22801, Base.promote_noncircular has been deprecated.

julia> Base.promote_noncircular
ERROR: UndefVarError: promote_noncircular not defined

But it still exists in v1.1.0 docs (even in master branch):

One risk with this design is the possibility that if there is no
suitable promotion method converting `x` and `y` to the same type, the
second method will recurse on itself infinitely and trigger a stack
overflow. The non-exported function `Base.promote_noncircular` can be
used as an alternative; when promotion fails it will still throw an
error, but one that fails faster with a more specific error message.

Should we remove

The non-exported function `Base.promote_noncircular` can be
used as an alternative; when promotion fails it will still throw an
error, but one that fails faster with a more specific error message.

or change it to

Current `promote` will throw an error directly.

or something similar?

@fredrikekre fredrikekre added docs This change adds or pertains to documentation good first issue Indicates a good issue for first-time contributors to Julia labels Jun 10, 2019
@JeffBezanson
Copy link
Member

Good catch. Yes, this should be changed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation good first issue Indicates a good issue for first-time contributors to Julia
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants