Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

allow documentation callbacks #386

Merged
merged 9 commits into from
Oct 1, 2022
Merged

Conversation

t-bltg
Copy link
Contributor

@t-bltg t-bltg commented Sep 30, 2022

Provide a way to give a documentation callback, when parsed c documentation is absent, implementation is tbd:

options = load_options(joinpath(@__DIR__, "generator.toml"))

options["general"]["callback_documentation"] = node -> String["This is the docstring generated for $(node.id)"]

For JuliaParallel/MPI.jl#652.

@t-bltg t-bltg changed the title Allow documentation callback allow documentation callbacks Sep 30, 2022
@t-bltg
Copy link
Contributor Author

t-bltg commented Oct 1, 2022

@Gnimuc, I've added specific tests for the configuration we use in MPI.jl.

Those also cover the previous PR: #385.

CI script was also refreshed and simplified.

test/runtests.jl Outdated Show resolved Hide resolved
test/mpi/mpi.h Show resolved Hide resolved
test/test_mpi.jl Outdated Show resolved Hide resolved
@Gnimuc
Copy link
Member

Gnimuc commented Oct 1, 2022

I will do a squash merge if there are no additional changes.

@t-bltg
Copy link
Contributor Author

t-bltg commented Oct 1, 2022

I'm done, pending CI does not fail.
Also, a version bump to 0.16.3 would be appreciated for our Project.toml (sorry for having to bump twice recently).

@Gnimuc Gnimuc merged commit 01e6794 into JuliaInterop:master Oct 1, 2022
@t-bltg t-bltg deleted the api_docs branch October 1, 2022 08:29
@t-bltg
Copy link
Contributor Author

t-bltg commented Oct 1, 2022

Thanks all for the valuable comments ;)

Gnimuc added a commit that referenced this pull request Nov 16, 2022
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.

3 participants