Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use jldoctest wherever possible #56921

Open
LilithHafner opened this issue Dec 30, 2024 · 2 comments
Open

Use jldoctest wherever possible #56921

LilithHafner opened this issue Dec 30, 2024 · 2 comments
Labels
docs This change adds or pertains to documentation good first issue Indicates a good issue for first-time contributors to Julia help wanted Indicates that a maintainer wants help on an issue or pull request

Comments

@LilithHafner
Copy link
Member

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.
@LilithHafner LilithHafner added docs This change adds or pertains to documentation help wanted Indicates that a maintainer wants help on an issue or pull request labels Dec 30, 2024
@LilithHafner LilithHafner mentioned this issue Dec 30, 2024
Merged
@inkydragon inkydragon added the good first issue Indicates a good issue for first-time contributors to Julia label Dec 31, 2024
@xyz-harshal
Copy link

xyz-harshal commented Jan 4, 2025 •
edited
Loading

can i work on this issue?

@inkydragon
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs This change adds or pertains to documentation good first issue Indicates a good issue for first-time contributors to Julia help wanted Indicates that a maintainer wants help on an issue or pull request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@inkydragon @LilithHafner @xyz-harshal