-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
atkeyword
macro to basedocs.jl, move some docs inline.
- Loading branch information
1 parent
be35ce8
commit 6f694f6
Showing
7 changed files
with
812 additions
and
683 deletions.
There are no files selected for viewing
This file contains 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
Oops, something went wrong.
6f694f6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible to do doctests in the keyword docs? Do those go anywhere in the rst right now?
6f694f6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be possible, just needs the examples to be changed to
jldoctest
and a test in the testsuite that evals all the doctest blocks inkeywords
. Might be worth generalising it to test all docstrings from the Julia-side rather than from sphinx though, since we're going to move everything over to markdown eventually. Maybe we need adoctest(::Module)
function built intoBase
.Not as far as I can see.
6f694f6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks.
Need a pure Julia implementation of this somewhere, doesn't necessarily have to be in base. It's not a big deal for doctest-running or html-building to require Docile or whatever other package IMO.