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 argument checking and documentation for FreeGroup, FreeMonoid, FreeSemigroup, FreeMagmaWithOne, and FreeMagma #4475

Merged
merged 3 commits into from
Jun 15, 2021
Merged

Improve argument checking and documentation for FreeGroup, FreeMonoid, FreeSemigroup, FreeMagmaWithOne, and FreeMagma #4475

merged 3 commits into from
Jun 15, 2021

Conversation

wilfwilson
Copy link
Member

@wilfwilson wilfwilson commented May 7, 2021 •
edited
Loading

This PR introduces a function FreeXArgumentProcessor to unify the argument processing for the following functions:

  • FreeSemigroup
  • FreeMonoid
  • FreeMagma
  • FreeMagmaWithOne
  • FreeGroup

This resolves the remaining problems raised in #1385. This also builds on #4111.

@wilfwilson wilfwilson added kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements topic: documentation Issues and PRs related to documentation do not merge PRs which are not yet ready to be merged (e.g. submitted for discussion, or test results) topic: library topic: error handling release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes labels May 7, 2021
@wilfwilson wilfwilson force-pushed the unify-free-object-error-checking branch 3 times, most recently from b0a76a4 to a49553e Compare May 12, 2021 11:08
@wilfwilson wilfwilson force-pushed the unify-free-object-error-checking branch from a49553e to 01f37c2 Compare June 10, 2021 23:08
@wilfwilson wilfwilson added release notes: use title For PRs: the title of this PR is suitable for direct use in the release notes and removed release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes labels Jun 10, 2021
@wilfwilson wilfwilson force-pushed the unify-free-object-error-checking branch 4 times, most recently from 058e9e6 to 4bf8e40 Compare June 11, 2021 01:34
@wilfwilson wilfwilson removed the do not merge PRs which are not yet ready to be merged (e.g. submitted for discussion, or test results) label Jun 11, 2021
@wilfwilson wilfwilson force-pushed the unify-free-object-error-checking branch 2 times, most recently from 497bc4f to 0573c13 Compare June 11, 2021 01:53
@wilfwilson
Copy link
Member Author

Whoops, this turned into a very big PR. I hope that it is not too difficult to review.

  • Many of the added lines are in test files/newly added manual examples, so don't need to be looked at too closely.
  • The different pieces of documentation are very similar, so there's not much point looking at more than one in any detail.

Changes in functionality:

@wilfwilson wilfwilson force-pushed the unify-free-object-error-checking branch 2 times, most recently from 50b51a0 to 02bdfec Compare June 11, 2021 02:14
@wilfwilson wilfwilson linked an issue Jun 11, 2021 that may be closed by this pull request
FreeMagma has unhelpful error messages, inconsistent argument checks, and can create incorrect 0-generator objects #1385
Closed
@wilfwilson
Update ViewString for rank-zero free groups/monoids
387bf9d
@wilfwilson
Introduce FreeXArgumentProcessor
2131b5f
@wilfwilson
Unify argument checking for some free objects
fb1463c 
In particular, unify argument processing/error checking in:
* `FreeSemigroup`
* `FreeMonoid`
* `FreeMagma`
* `FreeMagmaWithOne`
* `FreeGroup`

These now use the newly-added function `FreeXArgumentProcessor`.
Their documentation has also been updated, and tests added.

Resolves gap-system#1385.
@wilfwilson wilfwilson force-pushed the unify-free-object-error-checking branch from 02bdfec to fb1463c Compare June 15, 2021 10:03
@wilfwilson wilfwilson merged commit 24d01ee into gap-system:master Jun 15, 2021
@wilfwilson wilfwilson deleted the unify-free-object-error-checking branch June 15, 2021 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hulpke hulpke hulpke approved these changes

Assignees
No one assigned
Labels
kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements release notes: use title For PRs: the title of this PR is suitable for direct use in the release notes topic: documentation Issues and PRs related to documentation topic: error handling topic: library
Projects
None yet
Milestone
No milestone
2 participants
@wilfwilson @hulpke