Skip to content

Commit

Permalink
Add note about @meta placement while splicing docstrings (#922)
Browse files Browse the repository at this point in the history
  • Loading branch information
tribut authored and mortenpi committed Jan 10, 2019
1 parent e770964 commit 46abe28
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/src/man/doctests.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,10 @@ julia> foo(2)
and no state is shared between any code blocks.
To preserve definitions see [Preserving Definitions Between Blocks](@ref).

!!! note

If you rely on setup-code for doctests inside docstrings, included in the document with `@docs` or `@autodocs`, the `@meta` block must be in the markdown file that calls these macros and not within the docstrings themselves, otherwise they will be ignored.

## Filtering Doctests

A part of the output of a doctest might be non-deterministic, e.g. pointer addresses and timings.
Expand Down

0 comments on commit 46abe28

Please sign in to comment.