bazelbuild / bazelbuild/stardoc

General provider deprecated support (without an init)

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

Description

The html and markdown templates make use of `providerInfo.init.deprecated.docString` to support when a provider's initializer has a general deprecation comment; however the general provider doc string itself doesn't seem to support marking the whole provider as deprecated. It would be nice to see this added.

Contributor guide

Open the contributing guide

Research direction

Start by locating the HTML and Markdown templates and tracing how providerInfo.init.deprecated.docString is rendered. Compare that path with the general provider doc string handling, then verify that a provider-level deprecation is represented in generated documentation without an initializer.】【。

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.