Improve docstrings for MCMCThreads, MCMCDistributed, and MCMCSerial with usage examples

[Copilot]

The docstrings for the parallel sampling types (MCMCThreads, MCMCDistributed, and MCMCSerial) were previously unhelpful as they only provided a brief description without showing users how to actually use them.

Before

help?> MCMCThreads
search: MCMCThreads

  MCMCThreads

  The MCMCThreads algorithm allows users to sample MCMC chains in parallel using
  multiple threads.

After

help?> MCMCThreads
search: MCMCThreads Threads MCMCSerial

  MCMCThreads

  The MCMCThreads algorithm allows users to sample MCMC chains in parallel using multiple threads.

  Usage
  ≡≡≡≡≡

  sample(model, sampler, MCMCThreads(), N, nchains)

  See also sample.

Changes Made

1. Added Usage sections with clear function signatures showing exactly how to use each parallel sampling type with the sample function
2. Added "See also" references to the main sample function for more detailed documentation
3. Applied consistent improvements across all three types (MCMCThreads, MCMCDistributed, and MCMCSerial)

The docstrings now provide users with concrete examples of how to use these types while linking to the comprehensive sample function documentation for additional details.

Fixes #105.

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/1e0228a030642014fe5cfe68c2c0a818f9e3f522
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaArrays/FillArrays.jl/tarball/6a70198746448456524cb442b8af316927ff3e1a
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaArrays/StaticArraysCore.jl/tarball/192954ef1208c7019899fbf8049e717f92959682
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaBinaryWrappers/ZeroMQ_jll.jl/tarball/766d90db2817565b667c1cc9cc420d668f2e8dba
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaBinaryWrappers/libsodium_jll.jl/tarball/011b0a7331b41c25524b64dc42afc9683ee89026
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaCollections/AbstractTrees.jl/tarball/2d9c9a55f9c93e8887ad391fbae72f8ef55e1177
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaCollections/DataStructures.jl/tarball/6c72198e6a101cccdd4c9731d3985e904ba26037
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaCollections/LeftChildRightSiblingTrees.jl/tarball/95ba48564903b43b2462318aa243ee79d81135ff
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaCollections/OrderedCollections.jl/tarball/05868e21324cede2207c6f0f466b4bfef6d5e7ee
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaCollections/SortingAlgorithms.jl/tarball/64d974c2e6fdf07f8155b5b2ca2ffa9069b608d9
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaData/DataAPI.jl/tarball/abe83f3a2f1b857aac70ef8b269080af17764bbe
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaData/Missings.jl/tarball/ec4f7fbeab05d7747bdf98eb74d130a2a2ed298d
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaData/Parsers.jl/tarball/7d2f8f21da5db6a806faf7b9b292296da42b2810
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaData/Tables.jl/tarball/f2c1efbc8f3a609aadf318094f8fc5204bdaf344
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaDocs/DocStringExtensions.jl/tarball/7442a5dfe1ebb773c29cc2962a8980f47221d76c
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaFolds/InitialValues.jl/tarball/4da0f88e9a39111c2fa3add390ab15f3a44f3ca3
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaFolds/SplittablesBase.jl/tarball/e08a62abc517eb79667d0a29dc08a3b589516bb5
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaFolds2/BangBang.jl/tarball/26f41e1df02c330c4fa1e98d4aa2168fdafc9b1f
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaFolds2/MicroCollections.jl/tarball/44d32db644e84c75dab479f1bc15ee76a1a3618f
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaFolds2/Transducers.jl/tarball/7deeab4ff96b85c5f72c824cae53a1398da3d1cb
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaFunctional/CompositionsBase.jl/tarball/802bb88cd69dfd1509f6670416bd4434015693ad
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaIO/JSON.jl/tarball/31e996f0a15c7b280ba9f76636b3ff9e2ae58c9a
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaInterop/VersionParsing.jl/tarball/58d6e80b4ee071f5efd07fda82cb9fbe17200868
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaInterop/ZMQ.jl/tarball/2d060e1f014c07561817bf6f3c0eb66b309e04bd
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaLang/IJulia.jl/tarball/66b1f8d8b870814a079da381dd20416c53e73839
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaLang/JuliaSyntax.jl/tarball/937da4713526b96ac9a178e2035019d3b78ead4a
  • Triggering command: julia --project=. -e using Pkg; Pkg.add("JuliaFormatter"); using JuliaFormatter; format(".") (http block)
• https://api.github.com/repos/JuliaLang/PrecompileTools.jl/tarball/5aa36f7049a63a1528fe8f7c3f2113413ffd4e1f
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaLogging/LoggingExtras.jl/tarball/f02b56007b064fbfddb4c9cd60161b6dd0f40df3
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaLogging/ProgressLogging.jl/tarball/d95ed0324b0799843ac6f7a6a85e65fe4e5173f0
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaLogging/TerminalLoggers.jl/tarball/f133fab380933d042f6796eda4e130272ba520ca
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaMath/InverseFunctions.jl/tarball/a779299d77cd080bf77b97535acecd73e1c5e5cb
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaMath/IrrationalConstants.jl/tarball/e2222959fbc6c19554dc15174c81bf7bf3aa691c
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaObjects/Accessors.jl/tarball/3b86719127f50670efe356bc11073d84b4ed7a5d
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaObjects/ConstructionBase.jl/tarball/b4b092499347b18a015186eae3042f72267106cb
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaPackaging/JLLWrappers.jl/tarball/0533e564aae234aff59ab625543145446d8b6ec2
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaPackaging/Preferences.jl/tarball/0f27480397253da18fe2c12a4ba4eb9eb208bf3d
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaPackaging/Requires.jl/tarball/62389eeff14780bfe55195b7204c0d8738436d64
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaPy/Conda.jl/tarball/b19db3927f0db4151cb86d073689f2428e524576
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaStats/LogExpFunctions.jl/tarball/13ca9e2586b89836fd20cccf56e57e2b9ae7f38f
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaStats/Statistics.jl/tarball/ae3bb1eb3bba077cd276bc5cfc337cc65c3075c0
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaStats/StatsAPI.jl/tarball/9d72a13a3f4dd3795a195ac5a44d7d6ff5f552ff
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/JuliaStats/StatsBase.jl/tarball/2c962245732371acd51700dbb268af311bddd719
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/LilithHafner/AliasTables.jl/tarball/9876e1e164b144ca45e9e3198d0b689cadfed9ff
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/LilithHafner/PtrArrays.jl/tarball/1d36ef11a9aaf1e8b74dacc6a731dd1de8fd493d
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/MichaelHatherly/CommonMark.jl/tarball/351d6f4eaf273b753001b2de4dffb8279b100769
  • Triggering command: julia --project=. -e using Pkg; Pkg.add("JuliaFormatter"); using JuliaFormatter; format(".") (http block)
• https://api.github.com/repos/domluna/JuliaFormatter.jl/tarball/f512fefd5fdc7dd1ca05778f08f91e9e4c9fdc37
  • Triggering command: julia --project=. -e using Pkg; Pkg.add("JuliaFormatter"); using JuliaFormatter; format(".") (http block)
• https://api.github.com/repos/jw3126/ArgCheck.jl/tarball/f9e9a66c9b7be1ad7372bbd9b062d9230c30c5ce
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/jw3126/Setfield.jl/tarball/c5391c6ace3bc430ca630251d02ea9687169ca68
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/queryverse/DataValueInterfaces.jl/tarball/bfc1187b79289637fa0ef6d4436ebdfe6905cbd6
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/queryverse/IteratorInterfaceExtensions.jl/tarball/a3f24677c21f5bbe9d2a714f95dcd58337fb2856
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/queryverse/TableTraits.jl/tarball/c06b2f539df1c6efa794486abfb6ed2022561a39
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/timholy/ProgressMeter.jl/tarball/fbb92c6c56b34e1a2c4c36058f68f332bec840e7
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/tkf/Baselet.jl/tarball/aebf55e6d7795e02ca500a689d326ac979aaf89e
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/tkf/ConsoleProgressMonitor.jl/tarball/3ab7b2136722890b9af903859afcf457fa3059e8
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/tkf/DefineSingletons.jl/tarball/0fba8b706d0178b4dc7fd44a96a92382c9065c2c
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/tpapp/LogDensityProblems.jl/tarball/4e0128c1590d23a50dcdb106c7e2dbca99df85c0
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (http block)
• https://api.github.com/repos/vtjnash/Glob.jl/tarball/97285bbd5230dd766e9ef6749b80fc617126d496
  • Triggering command: julia --project=. -e using Pkg; Pkg.add("JuliaFormatter"); using JuliaFormatter; format(".") (http block)
• pkg.julialang.org
  • Triggering command: julia --project=. -e using Pkg; Pkg.test() (dns block)
  • Triggering command: julia --project=. -e using Pkg; Pkg.add("JuliaFormatter"); using JuliaFormatter; format(".") (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[Copilot]

@yebai 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

[yebai]

@penelopeysm can you help take a look at this?