# Validity of package documentation and examples

**URL:** <https://discourse.julialang.org/t/validity-of-package-documentation-and-examples/66217>\
**Category:** General Usage\
**Created:** [August 11, 2021, 6:47pm UTC](https://discourse.julialang.org/t/validity-of-package-documentation-and-examples/66217 "2021-08-11T18:47:51Z")\
**Posts on this page:** 1\
**Showing post:** 19

<div class="post-metadata">

**Author:** ![lmiq](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/lmiq/32/18314_2.png) [@lmiq](https://discourse.julialang.org/u/lmiq)\
**Post date:** [August 18, 2021, 11:58am UTC](https://discourse.julialang.org/t/validity-of-package-documentation-and-examples/66217/19 "2021-08-18T11:58:08Z")

</div>

> [@rikh](#):
>
> See my example above! Both problems are handled in the EffectSizes PR that I linked.

What if my package doesn’t have an actual Documenter-type documentation, only a README.md? I would like to test the examples of the README.md and ones of the function comments. Is there a way  
to do that, without having to copy/paste, which is prone to errors and cannot be scripted? ([as nov/2020 it appears there wasn’t one](https://discourse.julialang.org/t/is-there-a-way-to-test-individual-jldoctests/49930))

(something that did not get clear to me: if I use `jldoctest` in the README.md file, it will appear properly syntax highlighted in github, I mean, after some of these PRs?).

---

_[View the full topic](https://discourse.julialang.org/t/validity-of-package-documentation-and-examples/66217)._