Run regenerate_docs.sh #297
Conversation
alexeagle
changed the title
|
Looks like the problem was reported last time someone touched the docs, but then not followed up? |
|
|
||
| for filename in bazel-bin/docs/*_gen.md; do |
There was a problem hiding this comment.
I would prefer to avoid changing the rename logic here (and thus avoid changing all the outs in docs/BUILD) without a specific reason. The existing logic works, and "_gen" suffix in a generated doc file is a good signal.
docs/BUILD
Outdated
| @@ -6,132 +6,132 @@ licenses(["notice"]) | |||
| # the --incompatible_remap_main_repo flag. | |||
| stardoc( | |||
| name = "build_test_docs", | |||
| out = "build_test_doc_gen.md", | |||
There was a problem hiding this comment.
I don't see a good reason for the out renames here and below in docs/BUILD. "_gen" means a generated, not hand-written md doc.
There was a problem hiding this comment.
sure, I'll open a separate PR for that change and discuss my reasoning.
Seems that recent edits were done by hand? Is the generator script still functioning? - remove flag that no longer exists in recent bazel releases from regenerate_docs script - now uses markdown tables since that's what the pinned version of stardoc does
|
@tetromino is the intent for the docs to always be up-to-date? If so, the root cause here was a missing |
|
ping @tetromino would you like tests added here that assert the docs are always up-to-date? |
|
@alexeagle - yes, a test to check docs are up to date would be greatly appreciated (as a follow-up PR). |
it prints a convenient 'bazel run' command to update them, replacing the shell script Follow-up to bazelbuild#297 (comment)
it prints a convenient 'bazel run' command to update them, replacing the shell script Follow-up to bazelbuild#297 (comment)
it prints a convenient 'bazel run' command to update them, replacing the shell script Follow-up to bazelbuild#297 (comment)
it prints a convenient 'bazel run' command to update them, replacing the shell script Follow-up to bazelbuild#297 (comment)
Seems that recent edits were done by hand? Is the generator script still functioning?