bazelbuild / bazelbuild/stardoc

Error generating function docs on windows, related to line endings

Open
#42 0 comments 1 reaction 0 assignees View on GitHub
P4 type: bug
Dominant language
Java
Stars
118
Forks
51
PR merge metrics
No merged PRs in 30d

Description

Error is
```
ERROR: D:/b/7cfqmzbl/external/npm_bazel_terser/BUILD.bazel:32:1: Couldn't build file external/npm_bazel_terser/docs.raw: Generating proto for Starlark doc for docs failed (Exit 1)
Exception in thread "main" com.google.devtools.build.skydoc.rendering.DocstringParseException: Unable to generate documentation for function node_repositories (defined at internal/node/node_repositories.bzl:688:5) due to malformed docstring. Parse errors:
internal/node/node_repositories.bzl:688:5 line 2: the one-line summary should be followed by a blank line

at com.google.devtools.build.skydoc.rendering.FunctionUtil.fromNameAndFunction(FunctionUtil.java:61)
at com.google.devtools.build.skydoc.rendering.ProtoRenderer.appendStarlarkFunctionInfos(ProtoRenderer.java:58)
```
see https://github.com/bazelbuild/rules_nodejs/pull/1426/commits/299d2b512b7652e970325db0a77e44bbf46d35e2 - can probably repro there

Contributor guide

Open the contributing guide

Research direction

Use the linked rules_nodejs pull-request commit as the reproduction case and inspect the reported failure at internal/node/node_repositories.bzl:688:5. Run function-documentation generation on Windows and compare line-ending handling; done means the example generates docs without the malformed-docstring error.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.