Skip to content

Enhance documentation of algebraic closure #2129

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Enhance documentation of algebraic closure #2129

wants to merge 1 commit into from

Conversation

thofma
Copy link
Member

@thofma thofma commented Aug 13, 2025

  • make it agnostic to the encapsulating documentation (Nemo or Oscar)
  • collapse docstrings to make it not stand out in the Oscar
    documentation
  • make all docstrings self contained (with collapsed docstrings this
    should be fine)

Copy link

codecov bot commented Aug 13, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.08%. Comparing base (fcfa3d0) to head (6495183).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2129      +/-   ##
==========================================
- Coverage   88.13%   88.08%   -0.06%     
==========================================
  Files          99       99              
  Lines       36925    36925              
==========================================
- Hits        32545    32526      -19     
- Misses       4380     4399      +19     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@thofma thofma force-pushed the th/docac branch 2 times, most recently from 022636e to 4ea832e Compare August 14, 2025 04:11
@thofma thofma marked this pull request as ready for review August 14, 2025 04:11
@thofma thofma requested a review from fingolfin August 14, 2025 04:11
DocTestSetup = quote
using Nemo
end
```

# Algebraic numbers
# Algebraic closure of the rational numbers
Copy link
Member

Choose a reason for hiding this comment

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

This change will break building the Oscar docs as https://github.com/oscar-system/Oscar.jl/blob/575fe7ae72ef361730345763d468117753021708/docs/src/Fields/intro.md?plain=1#L16 won't reference anything anymore. But I don't think we can avoid that, so please just make sure to prepare a corresponding PR to Oscar that can be merged right after the release of this PR here

Copy link
Member Author

Choose a reason for hiding this comment

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

Will do.

- make it agnostic to the encapsulating documentation (Nemo or Oscar)
- collapse docstrings to make it not stand out in the Oscar
  documentation
- make all docstrings self contained (with collapsed docstrings this
  should be fine)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants