Skip to content

Create a method for usage instructions #222

@nathanjmcdougall

Description

@nathanjmcdougall

Motivation
At the moment there is a pattern arising which I think is harmful:

  1. Tool A integrates with tool B.
  2. When Tool A is being added, it checks whether B is being used. If so, it re-calls use_B so that new usage instructions which are relevant to A are displayed.
  3. Likewise, when Tool A is being removed, it checks whether B is being used. If so, it re-calls use_B so that the usage instructions relevant to not using A are displayed.

The issue is that sometimes usage instructions for the not-using-A case suggest using A! Given there is an integration at all, it makes sense we would want to recommend that. Also it degrades performance to run checks to ascertain whether a tool is used or not.

So one idea is that we wouldn't re-call use_B, we would just call specifically the message which is helpful which contains usage directions. The hints about using A etc. would remain in the place they currently are.

Summary of desired enhancement
Create method functions which specialize in usage instructions.

Metadata

Metadata

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions