IMP: skip private actions in describe_plugin - #20
Open
gregcaporaso wants to merge 2 commits into
Open
Conversation
Contributor
|
I don't think this will work as you want, because the plugin page will still include those actions. I think we need a few updates here as well: https://github.com/rachis-org/rachis-doc/blob/105d82adc00f8f0d188bd2551bdc4e5a26b2b229/q2doc/common.py |
Hidden actions (names starting with '_') were still emitted as their own pages in multi-page mode and as describe-action blocks in single-page mode, so they appeared in the docs despite being dropped from the Plugin Overview table in the previous commit. Skip them in both write_plugin loops, matching the describe_plugin change. Also adds the missing trailing newline. @gregcaporaso requested the follow-up to @ebolyen's review comment on #20; Claude located the two loops, made the edits, and smoke-tested against the fondue plugin in the amplicon-docs environment. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Contributor
Author
|
Thanks @ebolyen - I added the same logic in additional file you pointed me at. I did a test build and it seems to have worked. Is there anything you'd like me to check in particular? We could look at it together too if that's easier than doing a test build on your own. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Attempt to address #11. At present, hidden actions (i.e., those starting with
_) are listed in the Plugin Overview documentation. For example, from here:@ebolyen, do you know if this change will cover it? I'll work on some testing if you're not sure.
AI Disclosure
AI used in the second commit, primarily to review where additional edits were needed. The edit I made was just propagated to two other spots.