Skip to content
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

Documentation for certain rules is missing #6619

Closed
uri-canva opened this issue Nov 7, 2018 · 7 comments
Closed

Documentation for certain rules is missing #6619

uri-canva opened this issue Nov 7, 2018 · 7 comments
Assignees
Labels
P1 I'll work on this now. (Assignee required) team-Rules-Java Issues for Java rules type: documentation (cleanup)

Comments

@uri-canva
Copy link
Contributor

Description of the problem / feature request:

Documentation for certain rules (for example java_toolchain) is missing on latest docs.build.bazel.

Feature requests: what underlying problem are you trying to solve with this feature?

Read the docs.

Bugs: what's the simplest, easiest way to reproduce this bug? Please provide a minimal example if possible.

https://docs.bazel.build/versions/master/be/java.html

screen shot 2018-11-07 at 1 32 02 pm

Note the missing java_toolchain, compare with:

https://web.archive.org/web/20181021162843/https://docs.bazel.build/versions/master/be/java.html

screen shot 2018-11-07 at 1 32 10 pm

The source of the docs still exists on current master, so I don't think it's been removed intentionally:

@jin
Copy link
Member

jin commented Nov 9, 2018

cc @lberki

@jin
Copy link
Member

jin commented Jan 7, 2019

Doc for java_import is also broken:

0.20.0: https://docs.bazel.build/versions/0.20.0/be/java.html#java_import

java_import(name, deps, data, compatible_with, constraints, deprecation, distribs, exports, features, jars, licenses, neverlink, proguard_specs, restricted_to, runtime_deps, srcjar, tags, testonly, visibility)

0.21.0: https://docs.bazel.build/versions/0.21.0/be/java.html#java_import

java_import(name, deps, data, compatible_with, deprecation, distribs, exports, features, licenses, restricted_to, runtime_deps, tags, testonly, visibility)

@jin
Copy link
Member

jin commented Jan 7, 2019

cc @iirina @buchgr @fweikert

@Profpatsch
Copy link
Contributor

Profpatsch commented Jan 8, 2019

Please fix this, not finding this rule in the documentation cost me a considerable amount of time. 😢
Writing docs for implemented code is not all that that much work compared to writing the code in the first place.

@laurentlb laurentlb added the P1 I'll work on this now. (Assignee required) label Jan 8, 2019
@jin
Copy link
Member

jin commented Jan 8, 2019

Bisected to c1d7672.

jingwen@jingwen:/tmp
$ curl http://localhost:12345/versions/master/be/overview.html | grep java_runtime
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--100 37307  100 37307    0     0  2602k      0 --:--:-- --:--:-- --:--:-- 2802k

At 1db9e66, the commit before c1d7672

jingwen@jingwen:/tmp
$ curl http://localhost:12345/versions/master/be/overview.html | grep java_runtime
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--100 37666  100 37666    0     0  2627k      0 --:--:-                <a href="  java.html#java_runtime">
-             java_runtime
--:--:-- --:--:-- 2627k

@jin jin self-assigned this Jan 8, 2019
@jin
Copy link
Member

jin commented Jan 8, 2019

cc @cushon

@jin
Copy link
Member

jin commented Jan 8, 2019

Fix: #7061

@jin jin removed the untriaged label Jan 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P1 I'll work on this now. (Assignee required) team-Rules-Java Issues for Java rules type: documentation (cleanup)
Projects
None yet
Development

No branches or pull requests

4 participants