Skip to content
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

TropicalGeometry + PolyhedralGeometry: fixing references in documentation #3923

Merged
merged 9 commits into from
Aug 19, 2024

Conversation

YueRen
Copy link
Member

@YueRen YueRen commented Jul 8, 2024

Beginning fixing some documentation as discussed in #3915

Does anybody know how to correctly add a reference to the function rays for polyhedral complexes? Currently, [`rays(::PolyhedralComplex)`](@ref) links to rays for K3Chamber.

Copy link

codecov bot commented Jul 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.57%. Comparing base (2008cc6) to head (4c36ba7).
Report is 8 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3923      +/-   ##
==========================================
+ Coverage   84.55%   84.57%   +0.01%     
==========================================
  Files         596      597       +1     
  Lines       81994    82179     +185     
==========================================
+ Hits        69330    69502     +172     
- Misses      12664    12677      +13     
Files Coverage Δ
src/PolyhedralGeometry/Cone/properties.jl 90.24% <ø> (ø)
...PolyhedralGeometry/PolyhedralComplex/properties.jl 86.27% <ø> (ø)
src/PolyhedralGeometry/PolyhedralFan/properties.jl 98.33% <ø> (ø)
src/PolyhedralGeometry/Polyhedron/properties.jl 86.50% <ø> (ø)
...edralGeometry/Polyhedron/standard_constructions.jl 97.33% <ø> (ø)
src/TropicalGeometry/hypersurface.jl 88.13% <ø> (ø)
src/TropicalGeometry/variety_supertype.jl 44.64% <ø> (ø)

... and 9 files with indirect coverage changes

@YueRen YueRen marked this pull request as ready for review August 14, 2024 06:32
@YueRen
Copy link
Member Author

YueRen commented Aug 14, 2024

Modulo bugs that are currently affecting the entire documentation, see #4009, I think the pull request is ready to be reviewed.

The goal of the pull request is to make the documentation more explicit whilst keeping it slim by adding references to same-named functions in polyhedral geometry.

@YueRen YueRen requested a review from lkastner August 14, 2024 06:36
@YueRen
Copy link
Member Author

YueRen commented Aug 14, 2024

@lkastner Could you review the changes for me, please? I've had to add some bits to the documentation in polyhedral geometry, let me know if you are okay with that.

@YueRen YueRen marked this pull request as draft August 14, 2024 18:27
@YueRen YueRen changed the title TropicalGeometry: added references to PolyhedralGeometry TropicalGeometry + PolyhedralGeometry: fixing references in documentation Aug 15, 2024
@lgoettgens lgoettgens added documentation Improvements or additions to documentation topic: tropical geometry labels Aug 15, 2024
@YueRen YueRen marked this pull request as ready for review August 16, 2024 21:38
@joschmitt joschmitt closed this Aug 19, 2024
@joschmitt joschmitt reopened this Aug 19, 2024
@joschmitt joschmitt enabled auto-merge (squash) August 19, 2024 09:33
@joschmitt joschmitt merged commit 15be6ba into master Aug 19, 2024
54 of 55 checks passed
@joschmitt joschmitt deleted the yr/tropicalDocu branch August 19, 2024 10:22
HechtiDerLachs pushed a commit to HechtiDerLachs/Oscar.jl that referenced this pull request Sep 13, 2024
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 topic: tropical geometry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants