Use jldoctest wherever possible

[LilithHafner]

jldoctest didn't used to support repl mode so we have a bunch of code blocks with julia-repl tags that should really be jldoctest instead.

Or, if you're feeling ambitious, it would be nice to audit all code blocks (grep for ```) and make as many as possible jldoctest.

Advice for folks implementing this

• Read https://documenter.juliadocs.org/stable/man/doctests/
• Start with a small PR changing no more than 1 or 2 blocks
• Update the output so that it matches a REPL session (you can copy and paste into a REPL and see what prints)
• Check to see if doctests pass (instructions)

[xyz-harshal]

can i work on this issue?

[inkydragon]

can i work on this issue?

Of course, you can always contribute when the issue remains open.
Just open a PR.

I would recommend that a pr contain a small number of changes so that it's easy to review.

[Kunal-sharma24]

jldoctest didn't used to support repl mode so we have a bunch of code blocks with julia-repl tags that should really be jldoctest instead.

Or, if you're feeling ambitious, it would be nice to audit all code blocks (grep for ```) and make as many as possible jldoctest.

hey i just want to ask that to replace all the julia-repl to jldoctest did i have to replace it manually because the whole code contains minimum 750 changes

[inkydragon]

did i have to replace it manually

You don't need to replace them manually, but there may be many cases where you need to update the REPL output.
Or maybe some of the examples are platform-specific and have different return values on different platforms, so they shouldn't be labeled as julia-repl.

I recommend running doctest after the automatic replacement to check that the output matches.
Of course, you can also open a draft PR and let the CI check it for you and then fix the error.

Another suggestion is to have a PR that contains only a few changes to make it easier to review.

[LilithHafner]

PR: #57100

[JRS296]

@inkydragon I was browsing through the Julia project and came across this issue. Has it been resolved? And if not, could I take a look at trying to reolve it?

[LilithHafner]

The issue is still open and you can always contribute, just open a PR.

[vivekTiw120303]

Hello Sir, I have been working on this issue, and submitted a PR regarding the changes in collection,md file in doc/src/base, but i don't know why the buildkite/julia-master is failing for 5-6 times. Can u please guide me for this issue. I genuinely wanted to work on this issue.

[LilithHafner]

We can talk about that on the PR you opened :)

[persinammon4]

Hi, I wrote this PR for this task: #57840

It doesn't get all of the julia-repl's, just the ones in logging.jl and basedocs.jl.

In general, make -C doc doctest=true doesn't work on my computer, so I was hoping for a reviewer to quickly run that command on their computer. make doc does, though and the other steps work.

Edit: I have a similar issue as previous poster, multiple checks fail including buildkite/julia-master. Not sure why that'd be.

[persinammon4]

I don't think it's a good idea to change this, although I am new. The doctests are failing because the answers are randomized and so aren't exactly the same as the written answer of what it should be, even though the written answer is also randomized.

[LilithHafner]

Please use the thread associated with that PR to discuss it.