Skip to content

Follow-up to #5083: Minor Doc Fixes#5145

Merged
lgoettgens merged 8 commits intomasterfrom
MinorFixes
Jul 22, 2025
Merged

Follow-up to #5083: Minor Doc Fixes#5145
lgoettgens merged 8 commits intomasterfrom
MinorFixes

Conversation

@HereAround
Copy link
Copy Markdown
Member

@HereAround HereAround commented Jul 21, 2025

  • Add # Examples to all FTheoryTools docstring examples.
  • Enforce imperative in doc strings by renaming Returns to Return (and friends) in doc strings.

cc @apturner @emikelsons

@HereAround HereAround added topic: FTheoryTools release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes optimization Simpler/more performant code or more/better tests documentation Improvements or additions to documentation labels Jul 21, 2025
@HereAround HereAround requested a review from lgoettgens July 21, 2025 15:47
@HereAround
Copy link
Copy Markdown
Member Author

@lgoettgens As discussed last week, this is a follow-up to #5083. Please consider merging if you are satisfied.

@codecov
Copy link
Copy Markdown

codecov Bot commented Jul 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.84%. Comparing base (0ae639f) to head (526622b).
Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5145      +/-   ##
==========================================
- Coverage   84.85%   84.84%   -0.01%     
==========================================
  Files         710      710              
  Lines       95410    95466      +56     
==========================================
+ Hits        80964    81002      +38     
- Misses      14446    14464      +18     
Files with missing lines Coverage Δ
...ools/src/AbstractFTheoryModels/basic_attributes.jl 76.00% <ø> (ø)
...s/src/AbstractFTheoryModels/computed_attributes.jl 95.45% <ø> (ø)
.../FTheoryTools/src/AbstractFTheoryModels/methods.jl 52.69% <ø> (ø)
...rc/AbstractFTheoryModels/precomputed_attributes.jl 100.00% <ø> (ø)
...heoryTools/src/AbstractFTheoryModels/properties.jl 80.00% <ø> (ø)
...yTools/src/AbstractFTheoryModels/qsm_attributes.jl 100.00% <ø> (ø)
...ls/src/AbstractFTheoryModels/section_attributes.jl 100.00% <ø> (ø)
...al/FTheoryTools/src/FamilyOfG4Fluxes/attributes.jl 80.59% <ø> (ø)
.../FTheoryTools/src/FamilyOfG4Fluxes/constructors.jl 68.88% <ø> (ø)
...ental/FTheoryTools/src/FamilyOfG4Fluxes/methods.jl 96.96% <ø> (ø)
... and 20 more

... and 6 files with indirect coverage changes

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

@lgoettgens lgoettgens changed the title Follow-up to #5083: Minor Fixes Follow-up to #5083: Minor Doc Fixes Jul 21, 2025
@lgoettgens
Copy link
Copy Markdown
Member

lgoettgens commented Jul 21, 2025

Could you also check for words like Checks, Creates, Computes, and Constructs as the first word of a docstring. Those should also lose the s, analogous to Returns.

Comment thread experimental/FTheoryTools/src/FamilyOfG4Fluxes/attributes.jl Outdated
Comment thread experimental/FTheoryTools/src/FamilyOfG4Fluxes/properties.jl Outdated
Comment thread experimental/FTheoryTools/src/G4Fluxes/properties.jl Outdated
@HereAround
Copy link
Copy Markdown
Member Author

Could you also check for words like Checks, Creates, Computes, and Constructs as the first word of a docstring. Those should also lose the s, analogous to Returns.

I checked and modified all of these. In additions found Adds which I changed accordingly. I could not find anything else at the top of my head (Sets, Reads, Verifies, ...), so hopefully this is complete.

@HereAround HereAround requested a review from lgoettgens July 21, 2025 20:14
Copy link
Copy Markdown
Member

@lgoettgens lgoettgens left a comment

Choose a reason for hiding this comment

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

Thanks! I didn't check that you got all cases, but the cases you did change look good.

@lgoettgens lgoettgens merged commit 3301435 into master Jul 22, 2025
35 checks passed
@lgoettgens lgoettgens deleted the MinorFixes branch July 22, 2025 08:41
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 optimization Simpler/more performant code or more/better tests 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.

2 participants