Skip to content

bug: docs should say which version each feature / function / etc. was introduced in #27470

@dgoldstein0

Description

@dgoldstein0

Page link:

No response

Problem description (include actual vs expected text, if applicable):

Major programming languages/platforms like node.js and python in their docs list when each function / api was introduced. This makes it far easier to use the latest docs, yet actually be targeting or at least supporting an older version of the language. Bazel should do the same: each new function, new parameter, change in behavior etc. should be documented in bazel docs with which semver version it was introduced in.

some related discussion in: #9016 (comment)

Where do you see this issue? (include link to specific section of the page, if applicable)

I know of it most on the repository_ctx page as there were a lot of improvements / features added there over bazel 7 - I was at the time using bazel 6 and was misled by the latest docs that repository_ctx including features I couldn't actually use. In particular, repository_ctx.getenv was an api I wanted to use in bazel 6 that I discovered the hard way was not available until bazel 7.

Any other information you'd like to share?

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2We'll consider working on this in future. (Assignee optional)help wantedSomeone outside the Bazel team could own thisteam-DocumentationDocumentation improvements that cannot be directly linked to other team labelsteam-OSSIssues for the Bazel OSS team: installation, release processBazel packaging, websitetype: documentation (cleanup)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions