Skip to content

Make public API examples executable and document returns - #43

Merged
cvigilv merged 2 commits into
mainfrom
cv/fix31-documentation
Sep 17, 2026
Merged

cvigilv merged 2 commits into
mainfrom
cv/fix31-documentation

Conversation

@cvigilv

@cvigilv cvigilv commented Sep 15, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • document return types and result shapes for every exported API method and the low-level request function
  • replace inert or dependency-heavy examples with checked jldoctest and @example blocks
  • fix malformed documentation fences and the stale KEGGAPI.conv heading
  • tighten prose across the README, manual, public docstrings, and benchmarking guide
  • run doctests before deployment and make Documenter example failures fail the build

Validation

  • julia --project -e 'using Pkg; Pkg.test()'
  • julia --project=docs docs/make.jl
  • julia --project=docs -e 'using Documenter: DocMeta, doctest; using KEGGAPI; DocMeta.setdocmeta!(KEGGAPI, :DocTestSetup, :(using KEGGAPI); recursive=true); doctest(KEGGAPI)'
  • julia --project=test -e 'using Runic; Runic.main(["--check", "src/", "test/", "docs/"])'
  • Test.detect_ambiguities(KEGGAPI) returned 0

Closes #31

@codecov

codecov Bot commented Sep 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines Coverage Δ
src/Conv.jl 100.00% <ø> (ø)
src/Ddi.jl 100.00% <ø> (ø)
src/Find.jl 90.00% <ø> (ø)
src/Get.jl 93.02% <ø> (ø)
src/Info.jl 100.00% <ø> (ø)
src/Link.jl 96.42% <ø> (ø)
src/List.jl 100.00% <ø> (ø)
src/Requests.jl 100.00% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread src/Ddi.jl
and ten entries. Empty vectors and vectors with more than ten entries throw an
The KEGG DDI database records known adverse drug-drug interactions. A query with
multiple entries also returns pairwise interactions among those entries. Vector
inputs must contain between one and ten entries. Empty vectors and vectors with more than ten entries throw an

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is no longer the case. Remove

Comment thread src/Find.jl

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reject this change

@cvigilv
cvigilv merged commit fe940d1 into main Sep 17, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make public API examples executable and document returns

1 participant