Skip to content

Fix docstring inclusion of is_square #2197

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.

Sign up for GitHub

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

Merged
lgoettgens merged 1 commit into from
Dec 11, 2025
+9 −9
Merged

Fix docstring inclusion of is_square #2197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ RandomExtensions = "fb686558-2515-59ef-acaa-46db3789a887"
SHA = "ea8e919c-243c-51af-8825-aaa63cd721ce"

[compat]
AbstractAlgebra = "0.47.4"
AbstractAlgebra = "0.47.6"
FLINT_jll = "~301.400.0"
LinearAlgebra = "1.6"
Random = "1.6"
Expand Down
4 changes: 2 additions & 2 deletions docs/src/integer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,8 +325,8 @@ is_divisible_by(::ZZRingElem, ::Int)
is_divisible_by(::ZZRingElem, ::ZZRingElem)
```

```@docs
is_square(::ZZRingElem)
```@docs; canonical=false
is_square(::NCRingElement)
Copy link
Member

@fingolfin fingolfin Dec 11, 2025

Choose a reason for hiding this comment

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

I am OK with merging this as a "quick fix" but I wonder if we should not instead do it similar to how we did it in AA, and just have a list here:

The following standard ring methods are implemented for `ZZRingElem`:
- [`is_square`](@ref)
- ...

possibly followed by an example?

Copy link
Member Author

@lgoettgens lgoettgens Dec 11, 2025

Choose a reason for hiding this comment

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

I agree that this is not optimal right now, but I just wanted to do a mechanical change as a bandaid

```

```@docs
Expand Down
4 changes: 2 additions & 2 deletions docs/src/padic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,8 @@ julia> q = lift(QQ, divexact(a, b))

### Square root

```@docs
Base.sqrt(::PadicFieldElem)
```@docs; canonical=false
is_square(::NCRingElement)
```

**Examples**
Expand Down
4 changes: 2 additions & 2 deletions docs/src/puiseux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ for specific rings provided by Nemo.

### Special functions

```@docs
Base.sqrt(a::FlintPuiseuxSeriesElem{ZZLaurentSeriesRingElem})
```@docs; canonical=false
is_square(::NCRingElement)
```

```@docs
Expand Down
4 changes: 2 additions & 2 deletions docs/src/qadic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ q = lift(Zy, divexact(a, b))

### Square root

```@docs
Base.sqrt(::QadicFieldElem)
```@docs; canonical=false
is_square(::NCRingElement)
```

**Examples**
Expand Down
Loading