Skip to content

Codex doc improvements#1166

Open
james-d-mitchell wants to merge 56 commits intosemigroups:stable-5.6from
james-d-mitchell:codex-doc-improvements
Open

Codex doc improvements#1166
james-d-mitchell wants to merge 56 commits intosemigroups:stable-5.6from
james-d-mitchell:codex-doc-improvements

Conversation

@james-d-mitchell
Copy link
Copy Markdown
Collaborator

No description provided.

@james-d-mitchell james-d-mitchell added the documentation Issues and PRs related to documentation label Apr 1, 2026
codex and others added 3 commits April 1, 2026 20:32
@james-d-mitchell james-d-mitchell force-pushed the codex-doc-improvements branch from 32574b4 to 238f089 Compare April 1, 2026 19:32
@james-d-mitchell james-d-mitchell force-pushed the codex-doc-improvements branch from 238f089 to a11bc57 Compare April 1, 2026 19:38
Copy link
Copy Markdown
Collaborator

@Joseph-Edwards Joseph-Edwards left a comment

Choose a reason for hiding this comment

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

On the whole, I'm very impressed by Codex's performance here. I have a few suggestions that I have outlined below, but most of these are personal preferences rather than Codex being wrong.

<Returns>A free semigroup or monoid.</Returns>
<Description>
<C>FreeMonoidAndAssignGeneratorVars</C> is synonym with:
<C>FreeMonoidAndAssignGeneratorVars</C> is synonymous with:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I'm not sure if either synonymous or synonym are right here? Something like

A potential implementation of <C>FreeMonoidAndAssignGeneratorVars</C> is:

or something like that.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Good point will update.

james-d-mitchell and others added 2 commits April 4, 2026 10:55
Co-authored-by: Joe Edwards <80713360+Joseph-Edwards@users.noreply.github.com>
Co-authored-by: Joe Edwards <80713360+Joseph-Edwards@users.noreply.github.com>
@james-d-mitchell
Copy link
Copy Markdown
Collaborator Author

On the whole, I'm very impressed by Codex's performance here. I have a few suggestions that I have outlined below, but most of these are personal preferences rather than Codex being wrong.

Thanks @Joseph-Edwards. Just to mention this was Codex with me reviewing every suggested change one file at a time, not just letting it rip :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Issues and PRs related to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants