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

Name examples section in docstrings consistently #4376

Merged
merged 1 commit into from
Dec 3, 2024

Conversation

fingolfin
Copy link
Member

The Julia style guide suggest to use '# Examples' uniformly, even if
there is just one example.

The Julia style guide suggest to use '# Examples' uniformly, even if
there is just one example.
Copy link

codecov bot commented Dec 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.36%. Comparing base (13a2cd0) to head (26da930).
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4376      +/-   ##
==========================================
+ Coverage   84.34%   84.36%   +0.01%     
==========================================
  Files         651      652       +1     
  Lines       86749    86955     +206     
==========================================
+ Hits        73168    73359     +191     
- Misses      13581    13596      +15     
Files with missing lines Coverage Δ
...imental/BasisLieHighestWeight/src/UserFunctions.jl 92.30% <ø> (ø)
experimental/LieAlgebras/src/LieAlgebra.jl 88.36% <ø> (ø)
experimental/LieAlgebras/src/LieAlgebraModule.jl 88.71% <ø> (ø)
experimental/LieAlgebras/src/RootSystem.jl 93.18% <ø> (ø)
experimental/MatrixGroups/src/MatrixGroups.jl 52.94% <ø> (ø)
experimental/Schemes/src/Resolution_structure.jl 67.31% <ø> (ø)
experimental/Schemes/src/Resolution_tools.jl 88.77% <ø> (ø)
...CoveredProjectiveScheme/CoveredProjectiveScheme.jl 89.18% <ø> (ø)
.../AlgebraicGeometry/Schemes/Divisors/WeilDivisor.jl 77.15% <ø> (ø)
...ry/Schemes/ProjectiveSchemes/Objects/Attributes.jl 87.30% <ø> (ø)
... and 10 more

... and 4 files with indirect coverage changes

@lgoettgens lgoettgens added the documentation Improvements or additions to documentation label Dec 3, 2024
@fingolfin fingolfin merged commit 6da542a into master Dec 3, 2024
31 checks passed
@fingolfin fingolfin deleted the mh/docstring-example branch December 3, 2024 19:09
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants