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

Glitch in manual: unexpected extra method for base_ring appears #1143

Closed
fingolfin opened this issue Mar 4, 2022 · 5 comments
Closed

Glitch in manual: unexpected extra method for base_ring appears #1143

fingolfin opened this issue Mar 4, 2022 · 5 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@fingolfin
Copy link
Member

Reported by @wdecker : in the section Data Associated to Ideals of the manual, the documentation for base_ring(I::MPolyIdeal) unexpected also shows the docstring for base_ring(M::PMat) from Hecke.jl:

image

The corresponding section in ideals.md looks like this:

## Data Associated to Ideals

```@docs
base_ring(I::MPolyIdeal)
```
@fingolfin fingolfin added bug Something isn't working documentation Improvements or additions to documentation labels Mar 4, 2022
@thofma
Copy link
Collaborator

thofma commented Mar 4, 2022

Same as #548?

@fingolfin
Copy link
Member Author

Oh, quite possibly. But this one here is concrete, and an issue, while that one introduces the issue as a PR, which is ... odd...

So, I'd rather close that PR, and leave this issue open. As @thofma pointed out there, this is likely JuliaDocs/Documenter.jl#839 and/or JuliaDocs/Documenter.jl#1523

@thofma
Copy link
Collaborator

thofma commented Mar 4, 2022

I think the underlying issue is JuliaLang/julia#29437. In the past I had (someimes) success with moving the where around.

@ThomasBreuer
Copy link
Member

@fingolfin just for curiosity:
I had thought that reporting a problem via a pull request, as in #548, has the advantage that one can reproduce the situation.
When I open an issue, the problematic phenomenon may disappear because of (a side-effect of) some commit, perhaps without actually solving the problem.
So what is the recommended way to proceed, perhaps open both an issue and a pull request?

@fingolfin
Copy link
Member Author

We don't show base_ring anymore in the relevant section, so this is resolved in that sense at least

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants