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

Associate docs from a metapackage to the -lib, -tests etc. sub-packages #75

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

SuzanneSoy
Copy link
Contributor

@SuzanneSoy SuzanneSoy commented Apr 5, 2021

Given the following packages:

name: foo            tags: some-tag              has-docs: yes   implies: foo-lib, foo-doc, superfoo
name: foo-lib        tags: other-tag, foo        has-docs: yes   implies:
name: foo-doc        tags: third-tag, foo        has-docs: no    implies:
name: superfoo       tags: fourth-tag, foo       has-docs: no    implies:
name: foo-v2         tags: fifth-tag, foo        has-docs: no    implies:
name: scribble       tags: seventh-tag           has-docs: yes   implies:
name: scribble-bar   tags: sixth-tag, scribble   has-docs: no    implies:

this PR will show (in the main package list) the docs from foo and foo-doc in the package list entries for foo, foo-lib, foo-doc, superfoo. But it will not show the docs from scribble in the entry for scribble-bar.

The rule is:

  • if metapkg implies subpkg,
  • and subpkg has a tag named metapkg
  • then subpkg will list the docs from metapkg (if any) and the docs from any other sibbling subpkg.

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.

@SuzanneSoy
Copy link
Contributor Author

SuzanneSoy commented Apr 5, 2021

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.

@jeapostrophe
Copy link
Collaborator

This looks good to me @tonyg

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.

2 participants