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

[FR]: Document gazelle map_kind #284

Closed
siddharthab opened this issue Feb 29, 2024 · 0 comments · Fixed by #288
Closed

[FR]: Document gazelle map_kind #284

siddharthab opened this issue Feb 29, 2024 · 0 comments · Fixed by #288
Labels
enhancement New feature or request untriaged Requires traige

Comments

@siddharthab
Copy link
Contributor

What is the current behavior?

Not obvious to casual users how to use gazelle with aspect_rules_py

Describe the feature

We should document that users should add these gazelle directives to their top-level Python project BUILD file:

# gazelle:map_kind py_library py_library @aspect_rules_py//py:defs.bzl
# gazelle:map_kind py_binary py_binary @aspect_rules_py//py:defs.bzl
# gazelle:map_kind py_test py_test @aspect_rules_py//py:defs.bzl
@siddharthab siddharthab added the enhancement New feature or request label Feb 29, 2024
@github-actions github-actions bot added the untriaged Requires traige label Feb 29, 2024
alexeagle added a commit that referenced this issue Mar 2, 2024
@alexeagle
Add gazelle config note
6572135 
fixes #284
@alexeagle alexeagle mentioned this issue Mar 2, 2024
Merged
alexeagle added a commit that referenced this issue Mar 2, 2024
@alexeagle
Add gazelle config note (#288)
334dd44 
fixes #284

---

### Type of change

- Documentation (updates to documentation or READMEs)

### Test plan

None
@github-project-automation github-project-automation bot moved this to ✅ Done in Open Source Mar 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request untriaged Requires traige
Projects
Open Source
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add gazelle config note aspect-build/rules_py
1 participant
@siddharthab