Skip to content

FTheoryTools: Yet more documentation changes#5083

Merged
HereAround merged 22 commits intomasterfrom
MoreDocuFTheoryTools
Jul 21, 2025
Merged

FTheoryTools: Yet more documentation changes#5083
HereAround merged 22 commits intomasterfrom
MoreDocuFTheoryTools

Conversation

@HereAround
Copy link
Copy Markdown
Member

@HereAround HereAround commented Jul 7, 2025

Release notes:

  • #5083 Breaking: Remove support for set-functions of metadata attributes of literature models.
  • #5083 Breaking: Remove support for (most) has-functions, to tell if a (literature) model has a particular attribute.
  • #5083 Introduce add_torsion_section method.

Preview

Preview of the overhauled documentation should become available at https://docs.oscar-system.org/previews/PR5083/Experimental/FTheoryTools/introduction/.

What is in this PR

  • Explain model sections and alike clearly in the documentation.
  • Remove various set_* and has_* functions, and streamline the code
  • Cox ring of family of spaces is now a decorated ring, rather than a "plain" polynomial ring
  • Centrally define types for all section attributes and ensure correct type casting in add methods.
  • Add add_torsion_section method.
  • Split attributes of AbstractFTheoryModels according to content to organize them better.
  • Create functions for getters of precomputed data with macro to streamline code/enhance its maintainability.

@HereAround HereAround added topic: FTheoryTools release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes optimization Simpler/more performant code or more/better tests documentation Improvements or additions to documentation extra-long Also run the extra-long tests during CI. labels Jul 7, 2025
@HereAround HereAround force-pushed the MoreDocuFTheoryTools branch from 1c219bf to b316e35 Compare July 7, 2025 16:09
@codecov
Copy link
Copy Markdown

codecov Bot commented Jul 7, 2025

Codecov Report

Attention: Patch coverage is 79.78437% with 75 lines in your changes missing coverage. Please review.

Project coverage is 84.84%. Comparing base (bce167f) to head (1c0c511).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
.../FTheoryTools/src/AbstractFTheoryModels/methods.jl 3.77% 51 Missing ⚠️
.../FTheoryTools/src/LiteratureModels/constructors.jl 90.26% 11 Missing ⚠️
...ools/src/AbstractFTheoryModels/basic_attributes.jl 76.00% 6 Missing ⚠️
experimental/FTheoryTools/src/auxiliary.jl 70.58% 5 Missing ⚠️
...s/src/AbstractFTheoryModels/computed_attributes.jl 95.45% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5083      +/-   ##
==========================================
- Coverage   84.91%   84.84%   -0.07%     
==========================================
  Files         706      710       +4     
  Lines       95627    95432     -195     
==========================================
- Hits        81197    80974     -223     
- Misses      14430    14458      +28     
Files with missing lines Coverage Δ
...rc/AbstractFTheoryModels/precomputed_attributes.jl 100.00% <100.00%> (ø)
...heoryTools/src/AbstractFTheoryModels/properties.jl 80.00% <ø> (-13.11%) ⬇️
...yTools/src/AbstractFTheoryModels/qsm_attributes.jl 100.00% <100.00%> (ø)
...ls/src/AbstractFTheoryModels/section_attributes.jl 100.00% <100.00%> (ø)
...ntal/FTheoryTools/src/FamilyOfSpaces/attributes.jl 100.00% <100.00%> (ø)
...al/FTheoryTools/src/FamilyOfSpaces/constructors.jl 83.33% <100.00%> (+16.66%) ⬆️
...xperimental/FTheoryTools/src/G4Fluxes/auxiliary.jl 94.60% <ø> (ø)
...perimental/FTheoryTools/src/G4Fluxes/properties.jl 100.00% <100.00%> (ø)
...TheoryTools/src/HypersurfaceModels/constructors.jl 96.19% <ø> (ø)
...eoryTools/src/Serialization/hypersurface_models.jl 97.05% <ø> (ø)
... and 11 more

... and 2 files with indirect coverage changes

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

@HereAround HereAround force-pushed the MoreDocuFTheoryTools branch 22 times, most recently from 7c25394 to d120fed Compare July 14, 2025 09:16
@HereAround HereAround force-pushed the MoreDocuFTheoryTools branch from 93c34a3 to 4e8b8e5 Compare July 18, 2025 15:53
@HereAround HereAround marked this pull request as ready for review July 18, 2025 15:54
Copy link
Copy Markdown
Collaborator

@emikelsons emikelsons left a comment

Choose a reason for hiding this comment

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

Looks good with some changes in mind for a future PR.

@HereAround
Copy link
Copy Markdown
Member Author

HereAround commented Jul 21, 2025

I assume that @apturner is ok with these changes. At least - no complaints reached me since we discussed this PR last Thursday. As such, will now merge this.

@HereAround HereAround merged commit 0ae639f into master Jul 21, 2025
30 of 31 checks passed
@HereAround HereAround deleted the MoreDocuFTheoryTools branch July 21, 2025 15:24
lgoettgens pushed a commit that referenced this pull request Jul 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation extra-long Also run the extra-long tests during CI. optimization Simpler/more performant code or more/better tests release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes topic: FTheoryTools

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants