search

bazelbuild / stardoc

Stardoc: Starlark Documentation Generator
Apache License 2.0
107 stars 42 forks source link

Include `load` in summaries #216

Closed fmeum closed 3 months ago

fmeum commented 5 months ago

Rules, providers, functions and aspects now have a load statement in their summary. Aspects additionally include a copyable --aspects flag.

Fixes #95

fmeum commented 5 months ago

Some tests are failing due to differing repository names. I can look into this when there is general consensus on the approach. I'm also happy to make this new behavior configurable in the template.

fmeum commented 4 months ago

The WORKSPACE tests are failing since they use a different repo name for Stardoc, which now appears in load statements. How do you want me to deal with that?

tetromino commented 3 months ago

The WORKSPACE tests are failing since they use a different repo name for Stardoc, which now appears in load statements. How do you want me to deal with that?

Excellent question! We may have to tag those tests "manual" + bazel version for which the golden was generated; in #232, I am adding a way to auto-update tests whose goldens are valid only for a particular Bazel release.

fmeum commented 3 months ago

I'll wait for #232 then, let me know what I need to do after it has been merged.