Skip to content

Internal and documentation improvements#4486

Merged
HereAround merged 3 commits intooscar-system:masterfrom
HereAround:MoreImprovements
Jan 19, 2025
Merged

Internal and documentation improvements#4486
HereAround merged 3 commits intooscar-system:masterfrom
HereAround:MoreImprovements

Conversation

@HereAround
Copy link
Copy Markdown
Member

@HereAround HereAround commented Jan 19, 2025

  • Remove auxiliary function _strict_transform (no longer needed thx to Improve performance of strict transform under toric blowups #4484).
  • Allow users to access torsion_sections and add its documentation.
  • I found that the documentation of more functions was not linked/visible on the website.
  • Convenience method to compute a random flux with prescribed properties for an F-theory model.

I did not (yet) check in detail if all our docstrings are also quote in the docs folder/explained there. Note that those docstring that do not appear in the docs folder do not appear on the website. Maybe @emikelsons could verify if more is missing?

Modulo this (minor) caveat, the above should be ready for review.

@HereAround HereAround added topic: FTheoryTools enhancement New feature or request documentation Improvements or additions to documentation labels Jan 19, 2025
@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 19, 2025

Codecov Report

Attention: Patch coverage is 77.77778% with 4 lines in your changes missing coverage. Please review.

Project coverage is 84.39%. Comparing base (767415a) to head (7883d7b).
Report is 120 commits behind head on master.

Files with missing lines Patch % Lines
.../FTheoryTools/src/AbstractFTheoryModels/methods.jl 33.33% 4 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4486   +/-   ##
=======================================
  Coverage   84.39%   84.39%           
=======================================
  Files         672      672           
  Lines       88690    88697    +7     
=======================================
+ Hits        74846    74855    +9     
+ Misses      13844    13842    -2     
Files with missing lines Coverage Δ
...heoryTools/src/AbstractFTheoryModels/attributes.jl 99.60% <100.00%> (+<0.01%) ⬆️
...heoryTools/src/AbstractFTheoryModels/properties.jl 98.33% <100.00%> (+0.02%) ⬆️
...ental/FTheoryTools/src/FamilyOfG4Fluxes/methods.jl 100.00% <100.00%> (+10.00%) ⬆️
experimental/FTheoryTools/src/auxiliary.jl 80.75% <ø> (+0.91%) ⬆️
.../FTheoryTools/src/AbstractFTheoryModels/methods.jl 77.39% <33.33%> (-0.62%) ⬇️

... and 2 files with indirect coverage changes

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 and the tests pass

@HereAround HereAround merged commit e83727c into oscar-system:master Jan 19, 2025
@HereAround HereAround deleted the MoreImprovements branch January 19, 2025 16:10
@aaruni96 aaruni96 added the release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes label Jan 30, 2025
@emikelsons emikelsons changed the title [FTheoryTools] More improvements Internal and documentation improvements Feb 27, 2025
@emikelsons emikelsons 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 Feb 27, 2025
@HereAround HereAround added release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes and removed release notes: use title For PRs: the title of this PR is suitable for direct use in the release notes labels Feb 27, 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 enhancement New feature or request release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes topic: FTheoryTools

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants