Skip to content

Improve documentation of fields#5314

Merged
thofma merged 3 commits intomasterfrom
th/docfields
Sep 23, 2025
Merged

Improve documentation of fields#5314
thofma merged 3 commits intomasterfrom
th/docfields

Conversation

@thofma
Copy link
Copy Markdown
Collaborator

@thofma thofma commented Sep 14, 2025 •
edited
Loading

  • remove "class field theory"
  • add overview over "all" available fields
  • add a list of methods that work for any field/field element
  • link real and complex fields

@thofma
doc: improve fields documentation
c83a890 
- remove "class field theory"
- add overview over "all" available fields
- add a list of methods that work for any field/field element
@thofma thofma added 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 backport 1.5.x done has been backported to release branch 1.5 labels Sep 14, 2025
@thofma thofma changed the title doc: improve fields documentation Improve documentation of fields Sep 14, 2025
@thofma
Copy link
Copy Markdown
Collaborator Author

thofma commented Sep 14, 2025

preview: https://docs.oscar-system.org/previews/PR5314/

@thofma thofma added backport 1.5.x backport for release branch 1.5 and removed backport 1.5.x done has been backported to release branch 1.5 labels Sep 14, 2025
@thofma thofma requested review from fieker and fingolfin September 16, 2025 16:08
fingolfin
fingolfin reviewed Sep 17, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@fingolfin fingolfin left a comment

Choose a reason for hiding this comment

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

Great improvement, thank you! Just a few typos need to be fixed

Comment thread docs/src/Fields/interface.md Outdated
Comment thread docs/src/Fields/intro.md Outdated
Comment thread docs/src/Fields/intro.md Outdated
thofma and others added 2 commits September 18, 2025 07:15
@thofma @fingolfin
Apply suggestions from code review
91dfcb9 
Co-authored-by: Max Horn <max@quendi.de>
@thofma @fingolfin
Update docs/src/Fields/intro.md
6f81bac 
Co-authored-by: Max Horn <max@quendi.de>
@thofma thofma enabled auto-merge (squash) September 18, 2025 11:33
@thofma thofma requested a review from fingolfin September 18, 2025 11:33
@thofma
Copy link
Copy Markdown
Collaborator Author

thofma commented Sep 18, 2025

Fixed the typos, thanks

fingolfin
fingolfin approved these changes Sep 23, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@fingolfin fingolfin left a comment

Choose a reason for hiding this comment

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

Great, thanks a lot

@thofma thofma merged commit ed99f23 into master Sep 23, 2025
30 of 31 checks passed
@thofma thofma deleted the th/docfields branch September 23, 2025 07:45
@aaruni96 aaruni96 mentioned this pull request Nov 19, 2025
Merged
benlorenz pushed a commit that referenced this pull request Nov 19, 2025
@thofma @benlorenz
Improve documentation of fields (#5314)
b857847 
- remove "class field theory"
- add overview over "all" available fields
- add a list of methods that work for any field/field element

(cherry picked from commit ed99f23)
@benlorenz benlorenz mentioned this pull request Nov 19, 2025
Merged
24 tasks
@benlorenz benlorenz added backport 1.5.x done has been backported to release branch 1.5 and removed backport 1.5.x backport for release branch 1.5 labels Nov 20, 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

@fieker fieker Awaiting requested review from fieker

Assignees

No one assigned

Labels

backport 1.5.x done has been backported to release branch 1.5 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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@thofma @fingolfin @benlorenz