canonical / canonical/documentation-style-guide

Feature request - Rule to detect deprecated commands or features

Open
#72 1 comment 0 reactions 0 assignees View on GitHub
Priority: Low Type: feature
Dominant language
Python
Stars
22
Forks
41
PR merge metrics
No merged PRs in 30d

Description

I'd like to see an existence-style rule with a list of deprecated or otherwise banned commands and even features. The main intent is to detect them being used in code blocks and warn about the usage of a deprecated feature.

For example, `juju run-action`.

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the repository's existing existence-style rules and how they inspect code blocks. Determine where a list of deprecated commands or features would be defined and how warnings are expressed, using `juju run-action` as the example; done means the rule reliably warns when listed items appear in code blocks.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.