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

feat: add global functions to mdbook, allow documenting arguments and return values #296

Merged
merged 4 commits into from
Feb 20, 2025

Conversation

makspll
Copy link
Owner

@makspll makspll commented Feb 19, 2025

ladfile builder will now parse docstrings of the following kind:

/// Arguments:
/// * `arg_name1` : doc1
/// Returns:
/// * `return_name` : doc2

And attaches those to newly added documentation fields on the arguments of functions and return types.

Also refactors mdbook preprocessor slightly, to make use of these, as well as re-structures the generated markdown.

@makspll makspll changed the title feat: add global functions to mdbook preprocessor, allow documenting arguments and return values specifically feat: add global functions to mdbook preprocessor, allow documenting arguments and return values Feb 19, 2025
@makspll makspll changed the title feat: add global functions to mdbook preprocessor, allow documenting arguments and return values feat: add global functions to mdbook, allow documenting arguments and return values Feb 19, 2025
@makspll makspll enabled auto-merge (squash) February 19, 2025 23:50
@makspll makspll merged commit 630cac1 into main Feb 20, 2025
15 checks passed
@makspll makspll deleted the feat/improve-mdbook-preprocessor branch February 20, 2025 00:36
@github-actions github-actions bot mentioned this pull request Feb 20, 2025
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.

1 participant