-
Notifications
You must be signed in to change notification settings - Fork 4.3k
docs: don't warn about starlark_doc_extract output #27302
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
Conversation
The community already relies on this protobuf format, and that it is a default output of the starlark_doc_extract rule. Are there specific breaking changes you imagine making here? FYI @meisterT
|
Hmm. We do our best to evolve the structure of the output (the proto message format) in a backwards-compatible way. However, the content of the output is absolutely not stable; just to pick the most obvious example, the docstrings for builtin rule/macro attributes will change whenever they are updated in Bazel's source tree. So the exact output of Is there a better way of expressing this idea? |
|
@alexeagle , what do you think about the following wording to replace the old warning:
|
|
Sure, I think it's pretty obvious that the documentation strings aren't constant as changes land to the code being documented. want to update the PR? |
|
@alexeagle - yes, please |
|
Done, thanks! |
|
Thanks, sent for review internally |
The community already relies on this protobuf format, and that it is a default output of the starlark_doc_extract rule.
Are there specific breaking changes you imagine making here?
FYI @meisterT