Skip to content

[Feature Request]: Throw error when version is invalid in applies_to #2094

@colleenmcginnis

Description

@colleenmcginnis

Prerequisites

  • I have searched existing issues to ensure this feature hasn't already been requested
  • I have tested using the latest version of docs-builder

What problem are you trying to solve?

Currently if a version is invalid (not semver), we just hide the version altogether without throwing an error, warning, or hint. This is causing the docs to be inaccurate. For example, this functionality was added in 9.1, but because the version in the source file is invalid, there's nothing to communicate to users that this is only available in 9.1 and later.

Proposed Solution

We should throw an error or warning when a version is invalid so the user is aware.

Examples and Research

No response

Alternative Solutions

No response

Additional Context

There are currently 3 instances across docs the following repos / files that use invalid versions in applies_to.

I can fix these at the source. 🙂

How important is this feature to you?

Important

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions