DOC: Standardize docstrings in quadsums.jl to follow style guide #351
Conversation
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
Co-authored-by: Haruki1225 <[email protected]>
Copilot
AI
changed the title
[WIP] Update docstrings in quadsums.jl
DOC: Standardize docstrings in quadsums.jl to follow style guide
Oct 27, 2025
Copilot finished work on behalf of
Haruki1225
October 27, 2025 05:26
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.
Updated docstrings in
src/quadsums.jlto conform to the project's docstring style guide.Changes
#####to#(Arguments, Returns, Notes)@doc doc"""syntax for LaTeX/mathematical notation supportBoth
var_quadratic_sumandm_quadratic_sumdocstrings now follow the consistent formatting pattern used throughout the codebase.Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
https://api.github.com/repos/FluxML/MacroTools.jl/tarball/1e0228a030642014fe5cfe68c2c0a818f9e3f522julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/GunnarFarneback/Inflate.jl/tarball/d1b1b796e47d94588b3757fe84fbf65a5ec4a80djulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/GunnarFarneback/RegistryInstances.jl/tarball/ffd19052caf598b8653b99404058fce14828be51julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaArrays/ArrayInterface.jl/tarball/d81ae5489e13bc03567d4fbbb06c546a5e53c857julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaArrays/FillArrays.jl/tarball/173e4d8f14230a7523ae11b9a3fa9edb3e0efd78julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaArrays/StaticArrays.jl/tarball/b8693004b385c842357406e3af647701fe783f98julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaArrays/StaticArraysCore.jl/tarball/6ab403037779dae8c514bad259f32a447262455ajulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaBinaryWrappers/Expat_jll.jl/tarball/27af30de8b5445644e8ffe3bcb0d72049c089cf1julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaBinaryWrappers/FFTW_jll.jl/tarball/6d6219a004b8cf1e0b4dbe27a2860b8e04eba0bejulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaBinaryWrappers/Git_LFS_jll.jl/tarball/bb8471f313ed941f299aa53d32a94ab3bee08844julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaBinaryWrappers/Git_jll.jl/tarball/96fbb1a5c700942301cf65d8546690dd3b2a6a79julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaBinaryWrappers/IntelOpenMP_jll.jl/tarball/ec1debd61c300961f98064cfb21287613ad7f303julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaBinaryWrappers/Libiconv_jll.jl/tarball/be484f5c92fad0bd8acfef35fe017900b0b73809julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaBinaryWrappers/MKL_jll.jl/tarball/282cadc186e7b2ae0eeadbd7a4dffed4196ae2aajulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaBinaryWrappers/NLopt_jll.jl/tarball/b0154a615d5b2b6cf7a2501123b793577d0b9950julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaBinaryWrappers/OpenSSH_jll.jl/tarball/301412a644646fdc0ad67d0a87487466b491e53djulia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaBinaryWrappers/OpenSSL_jll.jl/tarball/f19301ae653233bc88b1810ae908194f07f8db9djulia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaBinaryWrappers/OpenSpecFun_jll.jl/tarball/1346c9208249809840c91b26703912dff463d335julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaBinaryWrappers/Rmath_jll.jl/tarball/58cdd8fb2201a6267e1db87ff148dd6c1dbd8ad8julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaBinaryWrappers/oneTBB_jll.jl/tarball/1350188a69a6e46f799d3945beef36435ed7262fjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaCollections/AbstractTrees.jl/tarball/2d9c9a55f9c93e8887ad391fbae72f8ef55e1177julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaCollections/DataStructures.jl/tarball/6c72198e6a101cccdd4c9731d3985e904ba26037julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaCollections/IterTools.jl/tarball/42d5f897009e7ff2cf88db414a389e5ed1bdd023julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaCollections/OrderedCollections.jl/tarball/05868e21324cede2207c6f0f466b4bfef6d5e7eejulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaCollections/SortingAlgorithms.jl/tarball/64d974c2e6fdf07f8155b5b2ca2ffa9069b608d9julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaDSP/DSP.jl/tarball/5989debfc3b38f736e69724818210c67ffee4352julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaData/DataAPI.jl/tarball/abe83f3a2f1b857aac70ef8b269080af17764bbejulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaData/Missings.jl/tarball/ec4f7fbeab05d7747bdf98eb74d130a2a2ed298djulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaData/Parsers.jl/tarball/7d2f8f21da5db6a806faf7b9b292296da42b2810julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaDiff/DiffResults.jl/tarball/782dd5f4561f5d267313f23853baaaa4c52ea621julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaDiff/DiffRules.jl/tarball/23163d55f885173722d1e4cf0f6110cdbaf7e272julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaDiff/DifferentiationInterface.jl/tarball/529bebbc74b36a4cfea09dd2aecb1288cd713a6djulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaDiff/FiniteDiff.jl/tarball/9340ca07ca27093ff68418b7558ca37b05f8aeb1julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaDiff/ForwardDiff.jl/tarball/ba6ce081425d0afb2bedd00d9884464f764a9225julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaDocs/ANSIColoredPrinters.jl/tarball/574baf8110975760d391c710b6341da1afa48d8cjulia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaDocs/DocStringExtensions.jl/tarball/7442a5dfe1ebb773c29cc2962a8980f47221d76cjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaDocs/Documenter.jl/tarball/352b9a04e74edd16429aec79f033620cf8e780d4julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaDocs/IOCapture.jl/tarball/b6d6bfdd7ce25b0f9b2f6b3dd56b2673a66c8770julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaDocs/MarkdownAST.jl/tarball/465a70f0fc7d443a00dcdc3267a497397b8a3899julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaGPU/Adapt.jl/tarball/7e35fca2bdfba44d797c53dfe63a51fabf39bfc0julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaGraphs/Graphs.jl/tarball/7a98c6502f4632dbe9fb1973a4244eaa3324e84djulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaIO/CodecZlib.jl/tarball/962834c22b66e32aa10f7611c08c8ca4e20749a9julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaIO/JSON.jl/tarball/06ea418d0c95878c8f3031023951edcf25b9e0efjulia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaIO/TranscodingStreams.jl/tarball/0c45878dcfdcfa8480052b6ab162cdd138781742julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaInterop/CEnum.jl/tarball/389ad5c84de1ae7cf0e28e381131c98ea87d54fcjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaLang/Compat.jl/tarball/9d8a54ce4b17aa5bdce0ea5c34bc5e7c340d16adjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaLang/PrecompileTools.jl/tarball/5aa36f7049a63a1528fe8f7c3f2113413ffd4e1fjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaLinearAlgebra/ArnoldiMethod.jl/tarball/d57bd3762d308bded22c3b82d033bff85f6195c6julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaMath/AbstractFFTs.jl/tarball/d92ad398961a3ed262d8bf04a1a2b8340f915fefjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaMath/Bessels.jl/tarball/4435559dc39793d53a9e3d278e185e920b4619efjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaMath/FFTW.jl/tarball/97f08406df914023af55ade2f843c39e99c5d969julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaMath/HypergeometricFunctions.jl/tarball/68c173f4f449de5b438ee67ed0c9c748dc31a2ecjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaMath/IntegerMathUtils.jl/tarball/4c1acff2dc6b6967e7e750633c50bc3b8d83e617julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaMath/IrrationalConstants.jl/tarball/b2d91fe939cae05960e760110b328288867b5758julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaMath/NaNMath.jl/tarball/9b8215b1ee9e78a293f99797cd31375471b2bcaejulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaMath/Polynomials.jl/tarball/972089912ba299fba87671b025cd0da74f5f54f7julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaMath/Primes.jl/tarball/25cdd1d20cd005b52fc12cb6be3f75faaf59bb9bjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaMath/QuadGK.jl/tarball/9da16da70037ba9d701192e27befedefb91ec284julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaMath/SpecialFunctions.jl/tarball/f2685b435df2613e25fc10ad8c26dddb8640f547julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaNLSolvers/LineSearches.jl/tarball/4adee99b7262ad2a1a4bbbc59d993d24e55ea96fjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaNLSolvers/NLSolversBase.jl/tarball/25a6638571a902ecfb1ae2a18fc1575f86b1d4dfjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaNLSolvers/Optim.jl/tarball/61942645c38dd2b5b78e2082c9b51ab315315d10julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaObjects/ConstructionBase.jl/tarball/b4b092499347b18a015186eae3042f72267106cbjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaPackaging/JLLWrappers.jl/tarball/0533e564aae234aff59ab625543145446d8b6ec2julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaPackaging/Preferences.jl/tarball/0f27480397253da18fe2c12a4ba4eb9eb208bf3djulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaPackaging/Requires.jl/tarball/62389eeff14780bfe55195b7204c0d8738436d64julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaPlots/Plots.jl/tarball/5c3d09cc4f31f5fc6af001c250bf1278733100ffjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaServices/StructUtils.jl/tarball/cd47aa083c9c7bdeb7b92de26deb46d6a33163c9julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/JuliaStats/Distributions.jl/tarball/3bc002af51045ca3b47d2e1787d6ce02e68b943ajulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaStats/LogExpFunctions.jl/tarball/13ca9e2586b89836fd20cccf56e57e2b9ae7f38fjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaStats/PDMats.jl/tarball/f07c06228a1c670ae4c87d1276b92c7c597fdda0julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaStats/Rmath.jl/tarball/5b3d50eb374cea306873b371d3f8d3915a018f0bjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaStats/Statistics.jl/tarball/ae3bb1eb3bba077cd276bc5cfc337cc65c3075c0julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaStats/StatsAPI.jl/tarball/9d72a13a3f4dd3795a195ac5a44d7d6ff5f552ffjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaStats/StatsBase.jl/tarball/a136f98cefaf3e2924a66bd75173d1c891ab7453julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaStats/StatsFuns.jl/tarball/91f091a8716a6bb38417a6e6f274602a19aaa685julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/JuliaVersionControl/Git.jl/tarball/824a1890086880696fc908fe12a17bcf61738bd8julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/KristofferC/LazilyInitializedFields.jl/tarball/0f2da712350b020bc3957f269c9caad516383ee0julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(http block)https://api.github.com/repos/LilithHafner/AliasTables.jl/tarball/9876e1e164b144ca45e9e3198d0b689cadfed9ffjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/LilithHafner/PtrArrays.jl/tarball/1d36ef11a9aaf1e8b74dacc6a731dd1de8fd493djulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/SciML/ADTypes.jl/tarball/27cecae79e5cc9935255f90c53bb831cc3c870d7julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/fredrikekre/EnumX.jl/tarball/bddad79635af6aec424f53ed8aad5d7555dc6f00julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/jump-dev/NLopt.jl/tarball/624785b15005a0e0f4e462b27ee745dbe5941863julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/jw3126/Setfield.jl/tarball/c5391c6ace3bc430ca630251d02ea9687169ca68julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/mauro3/Parameters.jl/tarball/34c0e9ad262e5f7fc75b10a9952ca7692cfc5fbejulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/mauro3/SimpleTraits.jl/tarball/be8eeac05ec97d379347584fa9fe2f5f76795bcbjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/mauro3/UnPack.jl/tarball/387c1f73762231e86e0c9c5443ce3b4a0a9a0c2bjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/rdeits/CommonSubexpressions.jl/tarball/cda2cfaebb4be89c9084adaca7dd7333369715c5julia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/simonster/Reexport.jl/tarball/45e428421666073eab6f2da5c9d310d99bb12f9bjulia --project=. -e using Pkg; Pkg.instantiate()(http block)https://api.github.com/repos/timholy/PositiveFactorizations.jl/tarball/17275485f373e6673f7e7f97051f703ed5b15b20julia --project=. -e using Pkg; Pkg.instantiate()(http block)pkg.julialang.orgjulia --project=. -e using Pkg; Pkg.instantiate()(dns block)/usr/local/julia1.11.7/bin/julia -C native -J/usr/local/julia1.11.7/lib/julia/sys.so -g1 --output-o /home/REDACTED/.julia/compiled/v1.11/MKL_jll/jl_dyQ6PR --output-ji /home/REDACTED/.julia/compiled/v1.11/MKL_jll/jl_foO1sJ --output-incremental=yes --startup-file=no --history-file=no --warn-overwrite=yes --color=yes -(dns block)julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.