bazelbuild / bazelbuild/stardoc

Support module docstrings

Open
#25 2 comments 0 reactions 0 assignees View on GitHub
P4 type: feature request
Dominant language
Java
Stars
118
Forks
51
PR merge metrics
No merged PRs in 30d

Description

Code change made in https://github.com/bazelbuild/bazel/commit/5faf9525ff1a9f3127139c8f5f5db3e2eb1481fe to support adding module docstrings to Stardoc output. The templates still need to be updated to reflect this new feature.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the referenced Bazel commit and the Stardoc templates it changed or enabled. Compare current Stardoc output with the module-docstring support described in the issue; done means the templates represent module docstrings in generated documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.