[patch] Run Doctest

[liamhuber]

Adds automatic testing of the docstring. I cut some corners on the deprecator example because I just couldn't get the output parsing to work nicely with the fact that it is a warning being printed and not plain output.

[github-actions]

👈 Launch a binder notebook on branch pyiron/pyiron_snippets/doctest

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +2.88% (target: -1.00%)	✅ ∅

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (bce8017)	451	414	91.80%
Head commit (2dbfdff)	451 (+0)	427 (+13)	94.68% (+2.88%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#18)	0	0	∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

---

_{🚀 Don’t miss a bit, follow what’s new on Codacy.}

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more}

[coveralls]

Pull Request Test Coverage Report for Build 9570593710

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+3.0%) to 94.47%

---

Totals
Change from base Build 9420542945:	3.0%
Covered Lines:	410
Relevant Lines:	434

---

💛 - Coveralls

[coveralls]

Pull Request Test Coverage Report for Build 9571690727

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+2.9%) to 94.678%

---

Totals
Change from base Build 9571433938:	2.9%
Covered Lines:	427
Relevant Lines:	451

---

💛 - Coveralls

[pmrv]

@deprecate I'm playing around just now, but it's all a bit awkward. Since there are the unit tests, we could just add #doctest: +SKIP for the examples in the docstring.

[coveralls]

Pull Request Test Coverage Report for Build 9581360703

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+2.9%) to 94.678%

---

Totals
Change from base Build 9571433938:	2.9%
Covered Lines:	427
Relevant Lines:	451

---

💛 - Coveralls

[coveralls]

Pull Request Test Coverage Report for Build 9585341114

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+2.9%) to 94.678%

---

Totals
Change from base Build 9571433938:	2.9%
Covered Lines:	427
Relevant Lines:	451

---

💛 - Coveralls

[liamhuber]

@pmrv perfect, thank you! I had been trying to accomplish something similar, but I think I was using #doctest: +IGNORE or some other syntax that was wrong and had talked myself into the idea it didn't work.

Now that you got the skip working, I've reverted my ugly formatting of the expected output.