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

Docs should have the name of file to load to get each rule. #545

Closed
aiuto opened this issue Feb 15, 2022 · 3 comments
Closed

Docs should have the name of file to load to get each rule. #545

aiuto opened this issue Feb 15, 2022 · 3 comments
Labels
P2 An issue that should be worked on when time is available
Milestone

Comments

@aiuto
Copy link
Collaborator

aiuto commented Feb 15, 2022

How do you know that you need to load @rules_pkg//pkg:zip.bzl to get pkg_zip?

Maybe fixed by #530.
But, perhaps we should fix it as part of #524

@aiuto aiuto added the P1 An issue that must be resolved. Must have an assignee label Feb 15, 2022
@aiuto aiuto added this to the 1.0 milestone Feb 15, 2022
@aiuto aiuto changed the title Docs to not have the name of file to load to get each rule. Docs should have the name of file to load to get each rule. Feb 15, 2022
@aiuto
Copy link
Collaborator Author

aiuto commented Feb 16, 2022

#530 got the information there, but it looks ugly.
I think folding it into the renderer from #524 is a better idea.

  • Can we automatically associate //pkg:tar.bzl with pkg_tar, even though the implementation is in pkg/private/tar? and wrapped in a macro?
  • It would be nice if the private part did not have to know where the public part was, but I can forgo that.
  • We should invent new syntax for this, so we can get a consistent rendering.
    perhaps @location("//pkg:tar.bzl")

@aiuto
Copy link
Collaborator Author

aiuto commented Mar 16, 2022

Lowering to P2 because there is something, but ugly. This is also something that should be part of stardoc.

@aiuto aiuto added P2 An issue that should be worked on when time is available and removed P1 An issue that must be resolved. Must have an assignee labels Mar 16, 2022
@aiuto
Copy link
Collaborator Author

aiuto commented Apr 5, 2022

This is as done as we are likely to get for now. If stardoc every adds the capability, we can update to that.

@aiuto aiuto closed this as completed Apr 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P2 An issue that should be worked on when time is available
Projects
None yet
Development

No branches or pull requests

1 participant