Associate docs from a metapackage to the -lib, -tests etc. sub-packages#75
Open
SuzanneSoy wants to merge 1 commit intoracket:masterfrom
Open
Associate docs from a metapackage to the -lib, -tests etc. sub-packages#75SuzanneSoy wants to merge 1 commit intoracket:masterfrom
SuzanneSoy wants to merge 1 commit intoracket:masterfrom
Conversation
Contributor
Author
|
This should remove all the "This package needs documentation" to-dos, as long as the authors add to the sub-packages a tag with the same name as the main metapackage. |
Collaborator
|
This looks good to me @tonyg |
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
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.
Given the following packages:
this PR will show (in the main package list) the docs from
fooandfoo-docin the package list entries forfoo,foo-lib,foo-doc,superfoo. But it will not show the docs fromscribblein the entry forscribble-bar.The rule is:
metapkgimpliessubpkg,subpkghas a tag namedmetapkgsubpkgwill list the docs frommetapkg(if any) and the docs from any other sibblingsubpkg.This is an initial fix for #58. A later version could add a proper 'metapackage or 'docs-of etc. field as suggested in some posts in that issue.