Add devdocs page on jldoctest practices #58506
Draft
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
Keno
force-pushed
the
codex/write-devdocs-page-on-jldoctests-best-practices
branch
from
a61c299 to
c9f6903
Compare
|
Although maybe this page doesn't go here, since the heading of the devdocs is "Documentation of Julia's internals". This is more of a "Contributor's guide" page. |
|
In fact, we already have a section on doctests in CONTRIBUTING.md that I forgot about: https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md#doctests |
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.
This adds a new devdoc page on best practices for writing devdocs. A primary motivation is to feed this to AI agents when you ask them to write new devdocs for you, so that you don't have to teach them how to do that from scratch. If we don't think this is valuable enough in the main devdocs, we could consider an
aidevdocsfolder.