bazelbuild / bazelbuild/bazel

command-line-reference options should be grouped by DocumentationCategory, not command

Open
#3,758 3 comments 0 reactions 1 assignee Claimed by @meisterT View on GitHub
not stale P3 team-Documentation team-OSS type: documentation (cleanup) type: feature request
Dominant language
Java
Stars
25.8k
Forks
4.6k
Avg merge
2d 20h
Merged PRs (30d)
72

Description

The current generated option documentation groups options by command. For options that are inherited through the command hierarchy (`test` inherits from `build`, etc), we don't list the options twice, but for options lists that are included in many commands explicitely, we list the option multiple times.

Instead of this cat and mouse game where, to find out if an option applies to a command, you see what command it's listed under and what other commands inherit from it, the options should just list the commands to which they apply:

```
--

Applies to commands :
```

At this point, each option would only need to be listed once, which means we could link to the option documentation clearly from elsewhere in the docs.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.