Add Documenter.jl documentation #74
Conversation
Co-authored-by: Claude <noreply@anthropic.com>
giordano
added
documentation
giordano
force-pushed
the
mg/docs
branch
4 times, most recently
from
9be3653 to
9600848
Compare
|
|
||
| ### Automatic Test Discovery | ||
|
|
||
| `ParallelTestRunner` automatically discovers all `.jl` files in your `test/` directory and subdirectories, excluding `runtests.jl`. |
There was a problem hiding this comment.
Another fun one here was that according to Claude setup.jl was also excluded automatically. No clue where it found it, no trace of setup.jl in the entire repository!
docs/src/index.md
Outdated
| ### Automatic Test Discovery | ||
|
|
||
| `ParallelTestRunner` automatically discovers all `.jl` files in your `test/` directory and subdirectories, excluding `runtests.jl`. | ||
| Tests are sorted by file size (largest first) for optimal load balancing. |
There was a problem hiding this comment.
Ah, this is also made up, I'm going to fix it....
docs/src/advanced.md
Outdated
| ## Custom Output Streams | ||
|
|
||
| You can redirect output to custom I/O streams: | ||
|
|
||
| ```julia | ||
| using ParallelTestRunner | ||
|
|
||
| io = IOBuffer() | ||
| runtests(MyPackage, ARGS; stdout=io, stderr=io) | ||
|
|
||
| # Process the output | ||
| output = String(take!(io)) | ||
| ``` | ||
|
|
||
| This is useful for: | ||
| - Capturing test output for analysis | ||
| - Writing to log files | ||
| - Suppressing output in certain contexts |
There was a problem hiding this comment.
This is technically not false, but I don't think it's really useful for end-users, it's mainly for testing the features of this package itself. I'm going to remove also this section.
giordano
force-pushed
the
mg/docs
branch
3 times, most recently
from
db6739d to
7624bbf
Compare
|
Alright, I'm mostly happy with the documentation now, I hope I removed all the rubbish. It can always be improved in later iterations |
|
I'm going to merge this otherwise I'll keep revising it forever, but please suggest follow up changes! |
Documentation largely written by Cursor/Claude, but I gave it a review and removed some non-sense (it had made up non-existing features like pressing
?to show the in-progress tests 🙄). I'll give it another review after making sure the workflow works.