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

[Stardoc] Cleanup new stardoc include issues, removing internal docs #785

Closed
wants to merge 1 commit into from
Closed

[Stardoc] Cleanup new stardoc include issues, removing internal docs #785

wants to merge 1 commit into from

Conversation

jerrymarino
Copy link
Contributor

  1. Export all files to bzl_srcs
  2. Remove mirror of includes into bzl_library
  3. Remove documentation of internal sources

Related: #783 #776

@jerrymarino
[Stardoc] Cleanup new stardoc include issues, removing internal docs
95f0456 
1. Export all files to `bzl_srcs`
2. Remove mirror of includes into `bzl_library`
3. Remove documentation of internal sources

Related: #783 #776
jszumski
jszumski reviewed Oct 20, 2023
View reviewed changes
rules/BUILD.bazel
bzl_library(
name = "xcconfig.doc",
srcs = ["xcconfig.doc.bzl"],
tags = ["manual"],
visibility = ["//visibility:public"],
deps = ["//rules/library:xcconfig"],
deps = ["bzl_srcs"],
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
deps = ["bzl_srcs"],
deps = [":bzl_srcs"],

rules/BUILD.bazel

# A library for all of the bzl_srcs, to satisfy `stardoc`'s deps attribute.
bzl_library(
name = "bzl_srcs",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would name = "bzl_deps" better reflect how this is used?

I'm not a stardoc expert, but is it an anti-pattern to just include the world here instead of being more targeted in the specific bzl_librarys above? Maybe we keep this to all external deps and leave in-repo ones on the individual libraries?

@luispadron
Copy link
Collaborator

I think if the intention here is to not have to define all the loads correctly because its a maintenance cost we should look at doing something similar to this PR: bazelbuild/rules_swift#1132 and just generate these targets.

@jerrymarino
Copy link
Contributor Author

I'm not tied to generating them with gazelle or starlark, the latter is likely a more simple way to tackle this but I'm happy to review a PR if you have a gazelle implementation for it.

@jerrymarino jerrymarino closed this Nov 9, 2023
@jerrymarino jerrymarino deleted the jmarino/cleanup_stardoc_issues branch November 9, 2023 21:56
@luispadron luispadron mentioned this pull request Nov 9, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jszumski jszumski jszumski left review comments

@luispadron luispadron Awaiting requested review from luispadron

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jerrymarino @luispadron @jszumski