Skip to content

Add $G$-set docstrings to main documentation#4594

Merged
fingolfin merged 6 commits intooscar-system:masterfrom
mjrodgers:GSet_doc2
Feb 19, 2025
Merged

Add $G$-set docstrings to main documentation#4594
fingolfin merged 6 commits intooscar-system:masterfrom
mjrodgers:GSet_doc2

Conversation

@mjrodgers
Copy link
Copy Markdown
Collaborator

@mjrodgers mjrodgers commented Feb 14, 2025

Resolves #3314

@mjrodgers
Copy link
Copy Markdown
Collaborator Author

mjrodgers commented Feb 14, 2025

These methods were flagged as being GSet related and missing from the documentation (action.md); however they DO all seem to be in the PermGroup documentaton (permgroup.md). I don't know how we want to proceed with this, we can either simply close this pull request / issue, or I could edit the pull request to migrate them from permgroup.md -> action.md.

@mjrodgers
Copy link
Copy Markdown
Collaborator Author

mjrodgers commented Feb 14, 2025

Alternately, I can add docstrings for the versions of these methods that take a GSet as the argument instead of a PermGroup (I added one for is_transitive, and could do the same for is_regular and is_semiregular; the other relevant functions currently return not implemented for this type of argument).

@mjrodgers mjrodgers marked this pull request as ready for review February 14, 2025 12:53
@fingolfin
Copy link
Copy Markdown
Member

fingolfin commented Feb 14, 2025

Morgan and me just discussed this and how to proceed, no need for comments until he has time to revise it. I am therefore marking this as a draft for now.

@fingolfin fingolfin marked this pull request as draft February 14, 2025 13:11
fingolfin
fingolfin reviewed Feb 14, 2025
View reviewed changes
Comment thread src/Groups/gsets.jl Outdated
fingolfin
fingolfin reviewed Feb 14, 2025
View reviewed changes
Comment thread src/Groups/gsets.jl Outdated
mjrodgers and others added 4 commits February 14, 2025 14:57
@mjrodgers @fingolfin
Update src/Groups/gsets.jl
1853ce8 
Co-authored-by: Max Horn <max@quendi.de>
@mjrodgers @fingolfin
Update src/Groups/gsets.jl
bb14185 
Co-authored-by: Max Horn <max@quendi.de>
@mjrodgers
minor
917eaf9
@mjrodgers
Consistent wording
fa64362
@mjrodgers mjrodgers marked this pull request as ready for review February 14, 2025 14:05
@lgoettgens lgoettgens added documentation Improvements or additions to documentation topic: groups labels Feb 14, 2025
@fingolfin fingolfin merged commit a2ff8d2 into oscar-system:master Feb 19, 2025
@fingolfin fingolfin changed the title add GSet dosctrings to main documentation Add $G$-set docstrings to main documentation Feb 27, 2025
@fingolfin fingolfin added the release notes: use title For PRs: the title of this PR is suitable for direct use in the release notes label Feb 27, 2025
@thofma thofma changed the title Add $G$-set docstrings to main documentation Add G-set docstrings to main documentation Feb 28, 2025
@fingolfin fingolfin changed the title Add G-set docstrings to main documentation Add $G$-set docstrings to main documentation Feb 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fingolfin fingolfin fingolfin approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation release notes: use title For PRs: the title of this PR is suitable for direct use in the release notes topic: groups

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Missing docstrings for a lot of G-set functionality

3 participants

@mjrodgers @fingolfin @lgoettgens