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.

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

Jump to bottom

Improve docstrings for is_conjugate/is_conjugate_with_data. #3384

Merged
merged 5 commits into from
Feb 28, 2024
Merged

Improve docstrings for is_conjugate/is_conjugate_with_data. #3384

merged 5 commits into from
Feb 28, 2024

Conversation

mjrodgers
Copy link
Collaborator

@mjrodgers mjrodgers commented Feb 19, 2024 •
edited
Loading

Improve docstrings for is_conjugate and is_conjugate_with_data methods, in particular making sure they reference each other where relevant.

Closes #3264 .

@thofma
Copy link
Collaborator

thofma commented Feb 19, 2024

If there is an issue with the return values of these methods, it should be a separate issue. This is just a quick update to the docstring here, which is independent of this discussion.

@joschmitt
Copy link
Member

If there is an issue with the return values of these methods, it should be a separate issue. This is just a quick update to the docstring here, which is independent of this discussion.

Yes, sorry.

@mjrodgers
Copy link
Collaborator Author

I see I messed up typesetting some LaTeX things so all tests are failing (although there had already been a $z$ before I made my edits that didn't seem to mess things up?). I will fix this real quick.

thofma
thofma reviewed Feb 19, 2024
View reviewed changes
src/Groups/GAPGroups.jl Outdated Show resolved Hide resolved
@mjrodgers @thofma
Update src/Groups/GAPGroups.jl
e7d4cd5 
Co-authored-by: Tommy Hofmann <thofma@gmail.com>
lgoettgens
lgoettgens reviewed Feb 19, 2024
View reviewed changes
src/Groups/GAPGroups.jl Outdated Show resolved Hide resolved
@mjrodgers @lgoettgens
Update src/Groups/GAPGroups.jl
c77075b 
Co-authored-by: Lars Göttgens <lars.goettgens@gmail.com>
@codecov Codecov
Copy link

codecov bot commented Feb 19, 2024

Codecov Report

Merging #3384 (c77075b) into master (7433548) will increase coverage by 0.01%.
Report is 2 commits behind head on master.
The diff coverage is 100.00%.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #3384      +/-   ##
==========================================
+ Coverage   82.06%   82.08%   +0.01%     
==========================================
  Files         557      557              
  Lines       73973    73971       -2     
==========================================
+ Hits        60704    60717      +13     
+ Misses      13269    13254      -15
Files Coverage Δ
src/Groups/GAPGroups.jl 92.78% <ø> (ø)
src/Groups/gsets.jl 88.72% <100.00%> (ø)

... and 1 file with indirect coverage changes

@fingolfin
Copy link
Member

@mjrodgers if you write fixes ISSUENUMBER or resolves ISSUENUMBER in the description of the issue, then merging the pull request will automatically close the referenced issue (see here for details)

@lgoettgens lgoettgens added documentation Improvements or additions to documentation backport 1.0.x Should be backported to the release 1.0 branch labels Feb 23, 2024
@benlorenz benlorenz mentioned this pull request Feb 26, 2024
Merged
31 tasks
@mjrodgers
Copy link
Collaborator Author

I believe this should be ready to merge

@fingolfin
Copy link
Member

Fine by me, but it would be good if @ThomasBreuer could have a look and approve (or request changes)

@fingolfin fingolfin enabled auto-merge (squash) February 28, 2024 01:31
ThomasBreuer
ThomasBreuer approved these changes Feb 28, 2024
View reviewed changes
Copy link
Member

@ThomasBreuer ThomasBreuer left a comment

Choose a reason for hiding this comment

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

Looks good, thanks.

@fingolfin fingolfin merged commit 95a1e27 into oscar-system:master Feb 28, 2024
19 of 20 checks passed
benlorenz pushed a commit that referenced this pull request Feb 28, 2024
@mjrodgers @benlorenz
Improve docstrings for is_conjugate/is_conjugate_with_data. (#3384)
b4bb046 
(cherry picked from commit 95a1e27)
@benlorenz benlorenz removed the backport 1.0.x Should be backported to the release 1.0 branch label Feb 28, 2024
mjrodgers added a commit to mjrodgers/Oscar.jl that referenced this pull request Feb 28, 2024
@mjrodgers
Improve docstrings for is_conjugate/is_conjugate_with_data. (osca…
dcf2e22 
…r-system#3384)
benlorenz added a commit that referenced this pull request Feb 29, 2024
@benlorenz
Backports for Oscar 1.0
0eb303b 
- Add QQBar docs to the manual #3423
- do not show the OscarInterface banner #3422
- fix bugs in all_OD_infos #3419
- Ep/ Rename Spec to AffineScheme #3345 #3425
- Remove two mentions of Arb_jll #3431
- Tweak epimorphism_from_free_group #3430
- CI: re-enable nightly #3435
- support gen(G::GAPGroup, 0) #3332
- Align all_*_groups methods some more #3433
- Add all_perfect_groups #3434
- Add all_primitive_groups and all_transitive_groups variants taking a single int or int range #3404
- fix a docstring #3436
- Fixes multivariate division #3396
- Docu invariants tori #3428
- Improve docstrings for is_conjugate/is_conjugate_with_data. #3384
- Fix ambient_module(M::SubquoModule) #3448
- Bugfix for printing of affine schemes #3437
- Bugfix for bugfix for printing of affine schemes #3445
- Update OSCAR banner #3410
- Docu invariants lin. red. groups (Lakshmi Ramesh and Wolfram Decker) #3443
- add od_from_atlas_group, od_from_p_subgroup, and helpers #3444
- Unexport normalise #3453
- support group properties for character tables #3449
- add docstrings for acting_group and action_function #3432 (exports are used in new groups code for the book)
- Adjust to renaming of rank(A::FinGenAbGroup) to torsion_free_rank(A::FinGenAbGroup) #3457
- Ensure fp_group(G) transfers group attributes #3464
- Added comment on convention #3467
- Export weierstrass_chart_on_minimal_model and patch transform_to_weierstrass #3458
- Fix a doc signature #3466
- Grading + caching for affine algebra of torus invariants #3469
@mjrodgers mjrodgers deleted the is_conjugate_doc branch March 1, 2024 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fingolfin fingolfin fingolfin left review comments

@thofma thofma thofma left review comments

@joschmitt joschmitt joschmitt left review comments

@lgoettgens lgoettgens lgoettgens left review comments

@ThomasBreuer ThomasBreuer ThomasBreuer approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve is_conjugate and is_conjugate_with_data docstrings
7 participants
@mjrodgers @thofma @joschmitt @fingolfin @ThomasBreuer @lgoettgens @benlorenz