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.

Sign up for GitHub

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

Jump to bottom

Show example load() call for each rule #95

Open
cvrebert opened this issue Apr 7, 2021 · 3 comments · May be fixed by #216
Open

Show example load() call for each rule #95

cvrebert opened this issue Apr 7, 2021 · 3 comments · May be fixed by #216
Labels
P4 type: feature request

Comments

@cvrebert
Copy link
Contributor

cvrebert commented Apr 7, 2021

Whenever I start using a new Starlark rule, the first step is to load() it in my BUILD file. Therefore it would be handy if the Stardoc output for each rule showed an appropriate load() statement that I could directly copy-paste. That way, users don't have to manually tweak the path to the .bzl file, change the final slash to a colon, etc., which is pure avoidable tedium.
@brandjon
Copy link
Member

That sounds like a nice feature. It might not be applicable in all environments since the repo might be imported by a different non-standard name in the user's WORKSPACE file, but that use is comparatively rare.

@alexeagle
Copy link
Contributor

FWIW I've started adding this feature in https://docs.aspect.dev

@tetromino
Copy link
Collaborator

Now that we have OriginKey in the protos, this should be fairly easy to implement in the renderer for anyone who is interested

@fmeum fmeum linked a pull request Apr 27, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
P4 type: feature request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Include load in summaries fmeum/stardoc
4 participants
@alexeagle @tetromino @cvrebert @brandjon