Repository navigation
Add Aqua and a docstring on every exported name - #9
Merged
Merged
Conversation
Aqua.test_all runs inside its own @testset, so a failing check fails the suite. Particle and ParticleList get docstrings; the docs build checks exported names with checkdocs = :exports. Co-Authored-By: Claude Opus 5.5 <[email protected]>
Julia counts the module name as exported, so it needs a docstring for every exported name to carry one. Base.Docs.undocumented_names is now empty. Co-Authored-By: Claude Opus 5.5 <[email protected]>
…g work checkdocs = :exports narrows the check to exported names, and Documenter 1.19.0 walks only Docs.meta, so an export without a docstring passes under either setting. The default :all checks at least as many names, so the narrower setting goes. The docs build passes with it. The CHANGELOG records Aqua and the three new docstrings. Co-Authored-By: Claude Opus 5.5 <[email protected]>
The constructor asserts that variable and parameter names are disjoint from each other and from the struct's field names. The Particle docstring already states its rule; ParticleList's now does too. Co-Authored-By: Claude Opus 5.5 <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #9 +/- ##
=======================================
Coverage 86.00% 86.00%
=======================================
Files 4 4
Lines 100 100
=======================================
Hits 86 86
Misses 14 14 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds Aqua to the test suite and a docstring to every exported name.
Aqua.test_all(ParticleMethods)runs inside its own@testset "Aqua", so a failing check fails the suite. All 11 checks pass, among them undefined exports.ParticleandParticleList. These were the only exported names without one.Base.Docs.undocumented_names(ParticleMethods)is now empty, and the library page renders all four names.docs/make.jlkeeps Documenter's defaultcheckdocs = :all.checkdocs = :exportswas considered and left out: Documenter 1.19.0 walks onlyDocs.meta, so neither setting finds an export that has no docstring, and:exportschecks fewer names.Pre-PR verification
Fixed
src/particle_list.jl: theParticleListdocstring now states the name rule that the constructor asserts. Variable and parameter names must not repeat each other or the field nameslist,views,params,particles,variables,indices. TheParticledocstring already states the same rule.Unresolved
Pre-existing (not changed here)
src/particle.jl:2:import Base.hasproperty, Base.getpropertyis redundant, because every method is defined with theBase.prefix.docs/make.jl:6: a stringrepomakes Documenter warn that it cannot find the navbar URL.Checked and clean
test_allin a testset: 11/11 pass on Aqua 0.8.18 and on 0.8.16.Pkg.test(): 81/81 on Julia 1.13.0, before the last two commits, which change only docstrings,docs/make.jland the CHANGELOG.ParticleMethods,Particle,ParticleListandeachparticle.fatou lintare clean on the changed lines.Not checked
minjob.🤖 Generated with Claude Code