Skip to content

Generate custom parameters' documentation for plugins #4414

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

Merged
merged 4 commits into from
Jun 8, 2025

Conversation

develop7
Copy link
Contributor

@develop7 develop7 commented Oct 8, 2024

Introduces a plugins-custom-config-markdown-reference subcommand which renders plugins' custom config parameters built-in documentation in a markdown document.

Fixes #3183

@develop7 develop7 force-pushed the feat-3183-gen_plugins_docs branch from 0781dd3 to 182bad5 Compare October 8, 2024 21:56
@develop7 develop7 marked this pull request as ready for review October 11, 2024 18:14
@develop7 develop7 force-pushed the feat-3183-gen_plugins_docs branch from 836f958 to e84845f Compare October 11, 2024 20:17
@fendor fendor added the status: needs review This PR is ready for review label Jan 2, 2025
Copy link
Collaborator

@fendor fendor left a comment

Choose a reason for hiding this comment

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

LGTM, needs to be regenerated for ghc 9.10 and 9.12

@develop7 develop7 force-pushed the feat-3183-gen_plugins_docs branch from fda2d80 to cb5539a Compare June 8, 2025 09:45
@develop7
Copy link
Contributor Author

develop7 commented Jun 8, 2025

I've rebased PR against master, c&pasted golden files for ghc910 & 912 and squashed whole PR into one commit. Let's see how tests will do.

@develop7 develop7 force-pushed the feat-3183-gen_plugins_docs branch from cb5539a to 369c229 Compare June 8, 2025 09:55
Introduces plugins-custom-config-markdown-reference subcommand
which extracts plugins' custom config parameters and
renders a Markdown table with all the reference information.
@develop7 develop7 force-pushed the feat-3183-gen_plugins_docs branch from 369c229 to 9fe40e6 Compare June 8, 2025 10:22
@develop7
Copy link
Contributor Author

develop7 commented Jun 8, 2025

@fendor 910 & 912 tests are green

@fendor fendor added merge me Label to trigger pull request merge and removed status: needs review This PR is ready for review labels Jun 8, 2025
Copy link
Contributor

mergify bot commented Jun 8, 2025

This pull request has been removed from the queue for the following reason: checks failed.

The merge conditions cannot be satisfied due to failing checks:

You may have to fix your CI before adding the pull request to the queue again.
If you update this pull request, to fix the CI, it will automatically be requeued once the queue conditions match again.
If you think this was a flaky issue instead, you can requeue the pull request, without updating it, by posting a @mergifyio requeue comment.

@mergify mergify bot merged commit 8aeda29 into haskell:master Jun 8, 2025
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge me Label to trigger pull request merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Auto-generate plugin options documentation
2 participants